#[non_exhaustive]pub struct OntapVolumeConfiguration {Show 16 fields
pub flex_cache_endpoint_type: Option<FlexCacheEndpointType>,
pub junction_path: Option<String>,
pub security_style: Option<SecurityStyle>,
pub size_in_megabytes: Option<i32>,
pub storage_efficiency_enabled: Option<bool>,
pub storage_virtual_machine_id: Option<String>,
pub storage_virtual_machine_root: Option<bool>,
pub tiering_policy: Option<TieringPolicy>,
pub uuid: Option<String>,
pub ontap_volume_type: Option<OntapVolumeType>,
pub snapshot_policy: Option<String>,
pub copy_tags_to_backups: Option<bool>,
pub snaplock_configuration: Option<SnaplockConfiguration>,
pub volume_style: Option<VolumeStyle>,
pub aggregate_configuration: Option<AggregateConfiguration>,
pub size_in_bytes: Option<i64>,
}Expand description
The configuration of an Amazon FSx for NetApp ONTAP volume.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.flex_cache_endpoint_type: Option<FlexCacheEndpointType>Specifies the FlexCache endpoint type of the volume. Valid values are the following:
-
NONEspecifies that the volume doesn't have a FlexCache configuration.NONEis the default. -
ORIGINspecifies that the volume is the origin volume for a FlexCache volume. -
CACHEspecifies that the volume is a FlexCache volume.
junction_path: Option<String>Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a JunctionPath directly below a parent volume junction or on a directory within a volume. A JunctionPath for a volume named vol3 might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even /dir1/dir2/vol3.
security_style: Option<SecurityStyle>The security style for the volume, which can be UNIX, NTFS, or MIXED.
size_in_megabytes: Option<i32>The configured size of the volume, in megabytes (MBs).
storage_efficiency_enabled: Option<bool>The volume's storage efficiency setting.
storage_virtual_machine_id: Option<String>The ID of the volume's storage virtual machine.
storage_virtual_machine_root: Option<bool>A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume.
This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM.
tiering_policy: Option<TieringPolicy>The volume's TieringPolicy setting.
uuid: Option<String>The volume's universally unique identifier (UUID).
ontap_volume_type: Option<OntapVolumeType>Specifies the type of volume. Valid values are the following:
-
RWspecifies a read/write volume.RWis the default. -
DPspecifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data. -
LSspecifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.
snapshot_policy: Option<String>Specifies the snapshot policy for the volume. There are three built-in snapshot policies:
-
default: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight. -
default-1weekly: This policy is the same as thedefaultpolicy except that it only retains one snapshot from the weekly schedule. -
none: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.
You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.
For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.
A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.
snaplock_configuration: Option<SnaplockConfiguration>The SnapLock configuration object for an FSx for ONTAP SnapLock volume.
volume_style: Option<VolumeStyle>Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.
aggregate_configuration: Option<AggregateConfiguration>This structure specifies configuration options for a volume’s storage aggregate or aggregates.
size_in_bytes: Option<i64>The configured size of the volume, in bytes.
Implementations§
Source§impl OntapVolumeConfiguration
impl OntapVolumeConfiguration
Sourcepub fn flex_cache_endpoint_type(&self) -> Option<&FlexCacheEndpointType>
pub fn flex_cache_endpoint_type(&self) -> Option<&FlexCacheEndpointType>
Specifies the FlexCache endpoint type of the volume. Valid values are the following:
-
NONEspecifies that the volume doesn't have a FlexCache configuration.NONEis the default. -
ORIGINspecifies that the volume is the origin volume for a FlexCache volume. -
CACHEspecifies that the volume is a FlexCache volume.
Sourcepub fn junction_path(&self) -> Option<&str>
pub fn junction_path(&self) -> Option<&str>
Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a JunctionPath directly below a parent volume junction or on a directory within a volume. A JunctionPath for a volume named vol3 might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even /dir1/dir2/vol3.
Sourcepub fn security_style(&self) -> Option<&SecurityStyle>
pub fn security_style(&self) -> Option<&SecurityStyle>
The security style for the volume, which can be UNIX, NTFS, or MIXED.
Sourcepub fn size_in_megabytes(&self) -> Option<i32>
pub fn size_in_megabytes(&self) -> Option<i32>
The configured size of the volume, in megabytes (MBs).
Sourcepub fn storage_efficiency_enabled(&self) -> Option<bool>
pub fn storage_efficiency_enabled(&self) -> Option<bool>
The volume's storage efficiency setting.
Sourcepub fn storage_virtual_machine_id(&self) -> Option<&str>
pub fn storage_virtual_machine_id(&self) -> Option<&str>
The ID of the volume's storage virtual machine.
Sourcepub fn storage_virtual_machine_root(&self) -> Option<bool>
pub fn storage_virtual_machine_root(&self) -> Option<bool>
A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume.
This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM.
Sourcepub fn tiering_policy(&self) -> Option<&TieringPolicy>
pub fn tiering_policy(&self) -> Option<&TieringPolicy>
The volume's TieringPolicy setting.
Sourcepub fn ontap_volume_type(&self) -> Option<&OntapVolumeType>
pub fn ontap_volume_type(&self) -> Option<&OntapVolumeType>
Specifies the type of volume. Valid values are the following:
-
RWspecifies a read/write volume.RWis the default. -
DPspecifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data. -
LSspecifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.
Sourcepub fn snapshot_policy(&self) -> Option<&str>
pub fn snapshot_policy(&self) -> Option<&str>
Specifies the snapshot policy for the volume. There are three built-in snapshot policies:
-
default: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight. -
default-1weekly: This policy is the same as thedefaultpolicy except that it only retains one snapshot from the weekly schedule. -
none: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.
You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.
For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.
A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.
Sourcepub fn snaplock_configuration(&self) -> Option<&SnaplockConfiguration>
pub fn snaplock_configuration(&self) -> Option<&SnaplockConfiguration>
The SnapLock configuration object for an FSx for ONTAP SnapLock volume.
Sourcepub fn volume_style(&self) -> Option<&VolumeStyle>
pub fn volume_style(&self) -> Option<&VolumeStyle>
Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.
Sourcepub fn aggregate_configuration(&self) -> Option<&AggregateConfiguration>
pub fn aggregate_configuration(&self) -> Option<&AggregateConfiguration>
This structure specifies configuration options for a volume’s storage aggregate or aggregates.
Sourcepub fn size_in_bytes(&self) -> Option<i64>
pub fn size_in_bytes(&self) -> Option<i64>
The configured size of the volume, in bytes.
Source§impl OntapVolumeConfiguration
impl OntapVolumeConfiguration
Sourcepub fn builder() -> OntapVolumeConfigurationBuilder
pub fn builder() -> OntapVolumeConfigurationBuilder
Creates a new builder-style object to manufacture OntapVolumeConfiguration.
Trait Implementations§
Source§impl Clone for OntapVolumeConfiguration
impl Clone for OntapVolumeConfiguration
Source§fn clone(&self) -> OntapVolumeConfiguration
fn clone(&self) -> OntapVolumeConfiguration
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for OntapVolumeConfiguration
impl Debug for OntapVolumeConfiguration
Source§impl PartialEq for OntapVolumeConfiguration
impl PartialEq for OntapVolumeConfiguration
Source§fn eq(&self, other: &OntapVolumeConfiguration) -> bool
fn eq(&self, other: &OntapVolumeConfiguration) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for OntapVolumeConfiguration
Auto Trait Implementations§
impl Freeze for OntapVolumeConfiguration
impl RefUnwindSafe for OntapVolumeConfiguration
impl Send for OntapVolumeConfiguration
impl Sync for OntapVolumeConfiguration
impl Unpin for OntapVolumeConfiguration
impl UnwindSafe for OntapVolumeConfiguration
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);