# Module `netapp_ontap.models.volume_efficiency`

Copyright © 2022 NetApp Inc. All rights reserved.

This file has been automatically generated based on the ONTAP REST API documentation.

## Classes

`class VolumeEfficiencySchema (*, only: Union[Sequence[str], Set[str]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Dict = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: str = None)`

  The fields of the VolumeEfficiency object

  ### Ancestors

  - netapp_ontap.resource.ResourceSchema
  - marshmallow.schema.Schema
  - marshmallow.base.SchemaABC

  ### Class variables

  `application_io_size: str GET POST PATCH`

    Block size to use by compression.

    Valid choices:

    - 8k
    - auto
  `compaction: str GET POST PATCH`

    The system can be enabled/disabled compaction.
    inline ‐ Data will be compacted first and written to the volume.
    none ‐ None
    mixed ‐ Read only field for FlexGroups, where some of the constituent volumes are compaction enabled and some are disabled.

    Valid choices:

    - inline
    - none
    - mixed
  `compression: str GET POST PATCH`

    The system can be enabled/disabled compression.
    inline ‐ Data will be compressed first and written to the volume.
    background ‐ Data will be written to the volume and compressed later.
    both ‐ Inline compression compresses the data and write to the volume, background compression compresses only the blocks on which inline compression is not run.
    none ‐ None
    mixed ‐ Read only field for FlexGroups, where some of the constituent volumes are compression enabled and some are disabled.
    Note that On volumes with container compression enabled, background compression refers to inactive data compression scan enabled on the volume.

    Valid choices:

    - inline
    - background
    - both
    - none
    - mixed
  `compression_type: str GET POST PATCH`

    Compression type to use by compression. Valid for PATCH and GET.

    Valid choices:

    - none
    - secondary
    - adaptive
  `cross_volume_dedupe: str GET POST PATCH`

    The system can be enabled/disabled cross volume dedupe. it can be enabled only when dedupe is enabled.
    inline ‐ Data will be cross volume deduped first and written to the volume.
    background ‐ Data will be written to the volume and cross volume deduped later.
    both ‐ Inline cross volume dedupe dedupes the data and write to the volume, background cross volume dedupe dedupes only the blocks on which inline dedupe is not run.
    none ‐ None
    mixed ‐ Read only field for FlexGroups, where some of the constituent volumes are cross volume dedupe enabled and some are disabled.

    Valid choices:

    - inline
    - background
    - both
    - none
    - mixed
  `dedupe: str GET POST PATCH`

    The system can be enabled/disabled dedupe.
    inline ‐ Data will be deduped first and written to the volume.
    background ‐ Data will be written to the volume and deduped later.
    both ‐ Inline dedupe dedupes the data and write to the volume, background dedupe dedupes only the blocks on which inline dedupe is not run.
    none ‐ None
    mixed ‐ Read only field for FlexGroups, where some of the constituent volumes are dedupe enabled and some are disabled.

    Valid choices:

    - inline
    - background
    - both
    - none
    - mixed
  `has_savings: bool GET`

    When true, indicates that the volume contains shared(deduplication, file clones) or compressed data.

  `last_op_begin: str GET`

    Last sis operation begin timestamp.

  `last_op_end: str GET`

    Last sis operation end timestamp.

  `last_op_err: str GET`

    Last sis operation error text.

  `last_op_size: Size GET`

    Last sis operation size.

  `last_op_state: str GET`

    Last sis operation state.

  `logging_enabled: bool GET`

    When true, indicates that space savings for any newly-written data are being logged.

  `op_state: str GET`

    Sis status of the volume.

    Valid choices:

    - idle
    - initializing
    - active
    - undoing
    - pending
    - downgrading
    - disabled
  `path: str GET`

    Absolute volume path of the volume.

  `policy: VolumeEfficiencyPolicy1 GET POST PATCH`

    The policy field of the volume_efficiency.

  `progress: str GET`

    Sis progress of the volume.

  `scanner: VolumeEfficiencyScanner GET POST PATCH`

    The scanner field of the volume_efficiency.

  `schedule: str GET`

    Schedule associated with volume.

  `space_savings: VolumeEfficiencySpaceSavings GET POST PATCH`

    The space_savings field of the volume_efficiency.

  `state: str GET POST PATCH`

    Storage efficiency state of the volume. Currently, this field supports POST/PATCH only for RW (Read-Write) volumes on FSx for ONTAP and Cloud Volumes ONTAP.
    disabled ‐ All storage efficiency features are disabled.
    mixed ‐ Read-only field for FlexGroup volumes, storage efficiency is enabled on certain constituents and disabled on others.
    On FSx for ONTAP and Cloud Volumes ONTAP ‐
    enabled ‐ All supported storage efficiency features for the volume are enabled.
    custom ‐ Read-only field currently only supported for the FSx for ONTAP and Cloud Volumes ONTAP, user-defined storage efficiency features are enabled.
    For other platforms ‐
    enabled ‐ At least one storage efficiency feature for the volume is enabled.

    Valid choices:

    - disabled
    - enabled
    - mixed
    - custom
  `storage_efficiency_mode: str GET POST PATCH`

    Storage efficiency mode used by volume. This parameter is supported only on AFF platform.

    Valid choices:

    - default
    - efficient
  `type: str GET`

    Sis Type of the volume.

    Valid choices:

    - regular
    - snapvault