TieringPolicy (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.fsx.model.TieringPolicy

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TieringPolicy
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes the data tiering policy for an ONTAP volume. When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns.

Valid tiering policies are the following:
- SNAPSHOT_ONLY - (Default value) moves cold snapshots to the capacity pool storage tier.
- AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
- ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
- NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.
See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

TieringPolicy()

Constructors
Constructor and Description
`TieringPolicy()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TieringPolicy`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getCoolingPeriod()` Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool.
`String`	`getName()` Specifies the tiering policy used to transition data.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCoolingPeriod(Integer coolingPeriod)` Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool.
`void`	`setName(String name)` Specifies the tiering policy used to transition data.
`String`	`toString()` Returns a string representation of this object.
`TieringPolicy`	`withCoolingPeriod(Integer coolingPeriod)` Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool.
`TieringPolicy`	`withName(String name)` Specifies the tiering policy used to transition data.
`TieringPolicy`	`withName(TieringPolicyName name)` Specifies the tiering policy used to transition data.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TieringPolicy
```
public TieringPolicy()
```
- Method Detail
  - setCoolingPeriod
```
public void setCoolingPeriod(Integer coolingPeriod)
```
    Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY.
    
    Parameters:
    
    coolingPeriod - Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY.
  - getCoolingPeriod
```
public Integer getCoolingPeriod()
```
    Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY.
    
    Returns:
    
    Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY.
  - withCoolingPeriod
```
public TieringPolicy withCoolingPeriod(Integer coolingPeriod)
```
    Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY.
    
    Parameters:
    
    coolingPeriod - Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY.
    - SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.
    - AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
    - ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
    - NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.
    Parameters:
    name - Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY.
    
    SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.
    
    AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
    
    ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
    
    NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.
    See Also:
    
    TieringPolicyName
  - getName
```
public String getName()
```
    Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY.
    - SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.
    - AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
    - ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
    - NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.
    Returns:
    Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY.
    
    SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.
    
    AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
    
    ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
    
    NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.
    See Also:
    
    TieringPolicyName
  - withName
```
public TieringPolicy withName(String name)
```
    Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY.
    - SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.
    - AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
    - ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
    - NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.
    Parameters:
    name - Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY.
    
    SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.
    
    AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
    
    ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
    
    NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TieringPolicyName
  - withName
```
public TieringPolicy withName(TieringPolicyName name)
```
    Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY.
    - SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.
    - AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
    - ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
    - NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.
    Parameters:
    name - Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY.
    
    SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.
    
    AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
    
    ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
    
    NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TieringPolicyName
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public TieringPolicy clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.793

Class TieringPolicy

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TieringPolicy

Method Detail

setCoolingPeriod

getCoolingPeriod

withCoolingPeriod

setName

getName

withName

withName

toString

equals

hashCode

clone

marshall