com.amazonaws.services.elasticfilesystem.model.LifecyclePolicy Maven / Gradle / Ivy
Show all versions of aws-java-sdk-efs Show documentation
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.elasticfilesystem.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Describes a policy used by EFS lifecycle management and EFS Intelligent-Tiering that specifies when to transition
* files into and out of the file system's Infrequent Access (IA) storage class. For more information, see EFS Intelligent‐Tiering and EFS
* Lifecycle Management.
*
*
*
* When using the put-lifecycle-configuration CLI command or the PutLifecycleConfiguration API
* action, Amazon EFS requires that each LifecyclePolicy object have only a single transition. This means
* that in a request body, LifecyclePolicies must be structured as an array of LifecyclePolicy
* objects, one object for each transition, TransitionToIA, TransitionToPrimaryStorageClass.
* For more information, see the request examples in PutLifecycleConfiguration.
*
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class LifecyclePolicy implements Serializable, Cloneable, StructuredPojo {
/**
*
* Describes the period of time that a file is not accessed, after which it transitions to IA storage. Metadata
* operations such as listing the contents of a directory don't count as file access events.
*
*/
private String transitionToIA;
/**
*
* Describes when to transition a file from IA storage to primary storage. Metadata operations such as listing the
* contents of a directory don't count as file access events.
*
*/
private String transitionToPrimaryStorageClass;
/**
*
* Describes the period of time that a file is not accessed, after which it transitions to IA storage. Metadata
* operations such as listing the contents of a directory don't count as file access events.
*
*
* @param transitionToIA
* Describes the period of time that a file is not accessed, after which it transitions to IA storage.
* Metadata operations such as listing the contents of a directory don't count as file access events.
* @see TransitionToIARules
*/
public void setTransitionToIA(String transitionToIA) {
this.transitionToIA = transitionToIA;
}
/**
*
* Describes the period of time that a file is not accessed, after which it transitions to IA storage. Metadata
* operations such as listing the contents of a directory don't count as file access events.
*
*
* @return Describes the period of time that a file is not accessed, after which it transitions to IA storage.
* Metadata operations such as listing the contents of a directory don't count as file access events.
* @see TransitionToIARules
*/
public String getTransitionToIA() {
return this.transitionToIA;
}
/**
*
* Describes the period of time that a file is not accessed, after which it transitions to IA storage. Metadata
* operations such as listing the contents of a directory don't count as file access events.
*
*
* @param transitionToIA
* Describes the period of time that a file is not accessed, after which it transitions to IA storage.
* Metadata operations such as listing the contents of a directory don't count as file access events.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TransitionToIARules
*/
public LifecyclePolicy withTransitionToIA(String transitionToIA) {
setTransitionToIA(transitionToIA);
return this;
}
/**
*
* Describes the period of time that a file is not accessed, after which it transitions to IA storage. Metadata
* operations such as listing the contents of a directory don't count as file access events.
*
*
* @param transitionToIA
* Describes the period of time that a file is not accessed, after which it transitions to IA storage.
* Metadata operations such as listing the contents of a directory don't count as file access events.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TransitionToIARules
*/
public LifecyclePolicy withTransitionToIA(TransitionToIARules transitionToIA) {
this.transitionToIA = transitionToIA.toString();
return this;
}
/**
*
* Describes when to transition a file from IA storage to primary storage. Metadata operations such as listing the
* contents of a directory don't count as file access events.
*
*
* @param transitionToPrimaryStorageClass
* Describes when to transition a file from IA storage to primary storage. Metadata operations such as
* listing the contents of a directory don't count as file access events.
* @see TransitionToPrimaryStorageClassRules
*/
public void setTransitionToPrimaryStorageClass(String transitionToPrimaryStorageClass) {
this.transitionToPrimaryStorageClass = transitionToPrimaryStorageClass;
}
/**
*
* Describes when to transition a file from IA storage to primary storage. Metadata operations such as listing the
* contents of a directory don't count as file access events.
*
*
* @return Describes when to transition a file from IA storage to primary storage. Metadata operations such as
* listing the contents of a directory don't count as file access events.
* @see TransitionToPrimaryStorageClassRules
*/
public String getTransitionToPrimaryStorageClass() {
return this.transitionToPrimaryStorageClass;
}
/**
*
* Describes when to transition a file from IA storage to primary storage. Metadata operations such as listing the
* contents of a directory don't count as file access events.
*
*
* @param transitionToPrimaryStorageClass
* Describes when to transition a file from IA storage to primary storage. Metadata operations such as
* listing the contents of a directory don't count as file access events.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TransitionToPrimaryStorageClassRules
*/
public LifecyclePolicy withTransitionToPrimaryStorageClass(String transitionToPrimaryStorageClass) {
setTransitionToPrimaryStorageClass(transitionToPrimaryStorageClass);
return this;
}
/**
*
* Describes when to transition a file from IA storage to primary storage. Metadata operations such as listing the
* contents of a directory don't count as file access events.
*
*
* @param transitionToPrimaryStorageClass
* Describes when to transition a file from IA storage to primary storage. Metadata operations such as
* listing the contents of a directory don't count as file access events.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TransitionToPrimaryStorageClassRules
*/
public LifecyclePolicy withTransitionToPrimaryStorageClass(TransitionToPrimaryStorageClassRules transitionToPrimaryStorageClass) {
this.transitionToPrimaryStorageClass = transitionToPrimaryStorageClass.toString();
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getTransitionToIA() != null)
sb.append("TransitionToIA: ").append(getTransitionToIA()).append(",");
if (getTransitionToPrimaryStorageClass() != null)
sb.append("TransitionToPrimaryStorageClass: ").append(getTransitionToPrimaryStorageClass());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof LifecyclePolicy == false)
return false;
LifecyclePolicy other = (LifecyclePolicy) obj;
if (other.getTransitionToIA() == null ^ this.getTransitionToIA() == null)
return false;
if (other.getTransitionToIA() != null && other.getTransitionToIA().equals(this.getTransitionToIA()) == false)
return false;
if (other.getTransitionToPrimaryStorageClass() == null ^ this.getTransitionToPrimaryStorageClass() == null)
return false;
if (other.getTransitionToPrimaryStorageClass() != null
&& other.getTransitionToPrimaryStorageClass().equals(this.getTransitionToPrimaryStorageClass()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTransitionToIA() == null) ? 0 : getTransitionToIA().hashCode());
hashCode = prime * hashCode + ((getTransitionToPrimaryStorageClass() == null) ? 0 : getTransitionToPrimaryStorageClass().hashCode());
return hashCode;
}
@Override
public LifecyclePolicy clone() {
try {
return (LifecyclePolicy) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.elasticfilesystem.model.transform.LifecyclePolicyMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}