com.amazonaws.services.recyclebin.model.RuleSummary Maven / Gradle / Ivy
Show all versions of aws-java-sdk-recyclebin Show documentation
/*
* Copyright 2019-2024 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.recyclebin.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Information about a Recycle Bin retention rule.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class RuleSummary implements Serializable, Cloneable, StructuredPojo {
/**
*
* The unique ID of the retention rule.
*
*/
private String identifier;
/**
*
* The retention rule description.
*
*/
private String description;
/**
*
* Information about the retention period for which the retention rule is to retain resources.
*
*/
private RetentionPeriod retentionPeriod;
/**
*
* The lock state for the retention rule.
*
*
* -
*
* locked - The retention rule is locked and can't be modified or deleted.
*
*
* -
*
* pending_unlock - The retention rule has been unlocked but it is still within the unlock delay
* period. The retention rule can be modified or deleted only after the unlock delay period has expired.
*
*
* -
*
* unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the
* required permissions.
*
*
* -
*
* null - The retention rule has never been locked. Once a retention rule has been locked, it can
* transition between the locked and unlocked states only; it can never transition back to
* null.
*
*
*
*/
private String lockState;
/**
*
* The Amazon Resource Name (ARN) of the retention rule.
*
*/
private String ruleArn;
/**
*
* The unique ID of the retention rule.
*
*
* @param identifier
* The unique ID of the retention rule.
*/
public void setIdentifier(String identifier) {
this.identifier = identifier;
}
/**
*
* The unique ID of the retention rule.
*
*
* @return The unique ID of the retention rule.
*/
public String getIdentifier() {
return this.identifier;
}
/**
*
* The unique ID of the retention rule.
*
*
* @param identifier
* The unique ID of the retention rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RuleSummary withIdentifier(String identifier) {
setIdentifier(identifier);
return this;
}
/**
*
* The retention rule description.
*
*
* @param description
* The retention rule description.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The retention rule description.
*
*
* @return The retention rule description.
*/
public String getDescription() {
return this.description;
}
/**
*
* The retention rule description.
*
*
* @param description
* The retention rule description.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RuleSummary withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* Information about the retention period for which the retention rule is to retain resources.
*
*
* @param retentionPeriod
* Information about the retention period for which the retention rule is to retain resources.
*/
public void setRetentionPeriod(RetentionPeriod retentionPeriod) {
this.retentionPeriod = retentionPeriod;
}
/**
*
* Information about the retention period for which the retention rule is to retain resources.
*
*
* @return Information about the retention period for which the retention rule is to retain resources.
*/
public RetentionPeriod getRetentionPeriod() {
return this.retentionPeriod;
}
/**
*
* Information about the retention period for which the retention rule is to retain resources.
*
*
* @param retentionPeriod
* Information about the retention period for which the retention rule is to retain resources.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RuleSummary withRetentionPeriod(RetentionPeriod retentionPeriod) {
setRetentionPeriod(retentionPeriod);
return this;
}
/**
*
* The lock state for the retention rule.
*
*
* -
*
* locked - The retention rule is locked and can't be modified or deleted.
*
*
* -
*
* pending_unlock - The retention rule has been unlocked but it is still within the unlock delay
* period. The retention rule can be modified or deleted only after the unlock delay period has expired.
*
*
* -
*
* unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the
* required permissions.
*
*
* -
*
* null - The retention rule has never been locked. Once a retention rule has been locked, it can
* transition between the locked and unlocked states only; it can never transition back to
* null.
*
*
*
*
* @param lockState
* The lock state for the retention rule.
*
* -
*
* locked - The retention rule is locked and can't be modified or deleted.
*
*
* -
*
* pending_unlock - The retention rule has been unlocked but it is still within the unlock delay
* period. The retention rule can be modified or deleted only after the unlock delay period has expired.
*
*
* -
*
* unlocked - The retention rule is unlocked and it can be modified or deleted by any user with
* the required permissions.
*
*
* -
*
* null - The retention rule has never been locked. Once a retention rule has been locked, it
* can transition between the locked and unlocked states only; it can never
* transition back to null.
*
*
* @see LockState
*/
public void setLockState(String lockState) {
this.lockState = lockState;
}
/**
*
* The lock state for the retention rule.
*
*
* -
*
* locked - The retention rule is locked and can't be modified or deleted.
*
*
* -
*
* pending_unlock - The retention rule has been unlocked but it is still within the unlock delay
* period. The retention rule can be modified or deleted only after the unlock delay period has expired.
*
*
* -
*
* unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the
* required permissions.
*
*
* -
*
* null - The retention rule has never been locked. Once a retention rule has been locked, it can
* transition between the locked and unlocked states only; it can never transition back to
* null.
*
*
*
*
* @return The lock state for the retention rule.
*
* -
*
* locked - The retention rule is locked and can't be modified or deleted.
*
*
* -
*
* pending_unlock - The retention rule has been unlocked but it is still within the unlock
* delay period. The retention rule can be modified or deleted only after the unlock delay period has
* expired.
*
*
* -
*
* unlocked - The retention rule is unlocked and it can be modified or deleted by any user with
* the required permissions.
*
*
* -
*
* null - The retention rule has never been locked. Once a retention rule has been locked, it
* can transition between the locked and unlocked states only; it can never
* transition back to null.
*
*
* @see LockState
*/
public String getLockState() {
return this.lockState;
}
/**
*
* The lock state for the retention rule.
*
*
* -
*
* locked - The retention rule is locked and can't be modified or deleted.
*
*
* -
*
* pending_unlock - The retention rule has been unlocked but it is still within the unlock delay
* period. The retention rule can be modified or deleted only after the unlock delay period has expired.
*
*
* -
*
* unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the
* required permissions.
*
*
* -
*
* null - The retention rule has never been locked. Once a retention rule has been locked, it can
* transition between the locked and unlocked states only; it can never transition back to
* null.
*
*
*
*
* @param lockState
* The lock state for the retention rule.
*
* -
*
* locked - The retention rule is locked and can't be modified or deleted.
*
*
* -
*
* pending_unlock - The retention rule has been unlocked but it is still within the unlock delay
* period. The retention rule can be modified or deleted only after the unlock delay period has expired.
*
*
* -
*
* unlocked - The retention rule is unlocked and it can be modified or deleted by any user with
* the required permissions.
*
*
* -
*
* null - The retention rule has never been locked. Once a retention rule has been locked, it
* can transition between the locked and unlocked states only; it can never
* transition back to null.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see LockState
*/
public RuleSummary withLockState(String lockState) {
setLockState(lockState);
return this;
}
/**
*
* The lock state for the retention rule.
*
*
* -
*
* locked - The retention rule is locked and can't be modified or deleted.
*
*
* -
*
* pending_unlock - The retention rule has been unlocked but it is still within the unlock delay
* period. The retention rule can be modified or deleted only after the unlock delay period has expired.
*
*
* -
*
* unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the
* required permissions.
*
*
* -
*
* null - The retention rule has never been locked. Once a retention rule has been locked, it can
* transition between the locked and unlocked states only; it can never transition back to
* null.
*
*
*
*
* @param lockState
* The lock state for the retention rule.
*
* -
*
* locked - The retention rule is locked and can't be modified or deleted.
*
*
* -
*
* pending_unlock - The retention rule has been unlocked but it is still within the unlock delay
* period. The retention rule can be modified or deleted only after the unlock delay period has expired.
*
*
* -
*
* unlocked - The retention rule is unlocked and it can be modified or deleted by any user with
* the required permissions.
*
*
* -
*
* null - The retention rule has never been locked. Once a retention rule has been locked, it
* can transition between the locked and unlocked states only; it can never
* transition back to null.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see LockState
*/
public RuleSummary withLockState(LockState lockState) {
this.lockState = lockState.toString();
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the retention rule.
*
*
* @param ruleArn
* The Amazon Resource Name (ARN) of the retention rule.
*/
public void setRuleArn(String ruleArn) {
this.ruleArn = ruleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the retention rule.
*
*
* @return The Amazon Resource Name (ARN) of the retention rule.
*/
public String getRuleArn() {
return this.ruleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the retention rule.
*
*
* @param ruleArn
* The Amazon Resource Name (ARN) of the retention rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RuleSummary withRuleArn(String ruleArn) {
setRuleArn(ruleArn);
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 (getIdentifier() != null)
sb.append("Identifier: ").append(getIdentifier()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getRetentionPeriod() != null)
sb.append("RetentionPeriod: ").append(getRetentionPeriod()).append(",");
if (getLockState() != null)
sb.append("LockState: ").append(getLockState()).append(",");
if (getRuleArn() != null)
sb.append("RuleArn: ").append(getRuleArn());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof RuleSummary == false)
return false;
RuleSummary other = (RuleSummary) obj;
if (other.getIdentifier() == null ^ this.getIdentifier() == null)
return false;
if (other.getIdentifier() != null && other.getIdentifier().equals(this.getIdentifier()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getRetentionPeriod() == null ^ this.getRetentionPeriod() == null)
return false;
if (other.getRetentionPeriod() != null && other.getRetentionPeriod().equals(this.getRetentionPeriod()) == false)
return false;
if (other.getLockState() == null ^ this.getLockState() == null)
return false;
if (other.getLockState() != null && other.getLockState().equals(this.getLockState()) == false)
return false;
if (other.getRuleArn() == null ^ this.getRuleArn() == null)
return false;
if (other.getRuleArn() != null && other.getRuleArn().equals(this.getRuleArn()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getIdentifier() == null) ? 0 : getIdentifier().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getRetentionPeriod() == null) ? 0 : getRetentionPeriod().hashCode());
hashCode = prime * hashCode + ((getLockState() == null) ? 0 : getLockState().hashCode());
hashCode = prime * hashCode + ((getRuleArn() == null) ? 0 : getRuleArn().hashCode());
return hashCode;
}
@Override
public RuleSummary clone() {
try {
return (RuleSummary) 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.recyclebin.model.transform.RuleSummaryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}