com.amazonaws.services.s3control.model.S3InitiateRestoreObjectOperation Maven / Gradle / Ivy
Show all versions of aws-java-sdk-s3control 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.s3control.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* Contains the configuration parameters for a POST Object restore job. S3 Batch Operations passes every object to the
* underlying RestoreObject API operation. For more information about the parameters for this operation,
* see RestoreObject.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class S3InitiateRestoreObjectOperation implements Serializable, Cloneable {
/**
*
* This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive object remains available in Amazon S3.
* S3 Initiate Restore Object jobs that target S3 Glacier and S3 Glacier Deep Archive objects require
* ExpirationInDays set to 1 or greater.
*
*
* Conversely, do not set ExpirationInDays when creating S3 Initiate Restore Object jobs that
* target S3 Intelligent-Tiering Archive Access and Deep Archive Access tier objects. Objects in S3
* Intelligent-Tiering archive access tiers are not subject to restore expiry, so specifying
* ExpirationInDays results in restore request failure.
*
*
* S3 Batch Operations jobs can operate either on S3 Glacier and S3 Glacier Deep Archive storage class objects or on
* S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier objects, but not both types in the
* same job. If you need to restore objects of both types you must create separate Batch Operations jobs.
*
*/
private Integer expirationInDays;
/**
*
* S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the
* EXPEDITED retrieval tier.
*
*/
private String glacierJobTier;
/**
*
* This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive object remains available in Amazon S3.
* S3 Initiate Restore Object jobs that target S3 Glacier and S3 Glacier Deep Archive objects require
* ExpirationInDays set to 1 or greater.
*
*
* Conversely, do not set ExpirationInDays when creating S3 Initiate Restore Object jobs that
* target S3 Intelligent-Tiering Archive Access and Deep Archive Access tier objects. Objects in S3
* Intelligent-Tiering archive access tiers are not subject to restore expiry, so specifying
* ExpirationInDays results in restore request failure.
*
*
* S3 Batch Operations jobs can operate either on S3 Glacier and S3 Glacier Deep Archive storage class objects or on
* S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier objects, but not both types in the
* same job. If you need to restore objects of both types you must create separate Batch Operations jobs.
*
*
* @param expirationInDays
* This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive object remains available in
* Amazon S3. S3 Initiate Restore Object jobs that target S3 Glacier and S3 Glacier Deep Archive objects
* require ExpirationInDays set to 1 or greater.
*
* Conversely, do not set ExpirationInDays when creating S3 Initiate Restore Object jobs
* that target S3 Intelligent-Tiering Archive Access and Deep Archive Access tier objects. Objects in S3
* Intelligent-Tiering archive access tiers are not subject to restore expiry, so specifying
* ExpirationInDays results in restore request failure.
*
*
* S3 Batch Operations jobs can operate either on S3 Glacier and S3 Glacier Deep Archive storage class
* objects or on S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier objects, but not
* both types in the same job. If you need to restore objects of both types you must create separate
* Batch Operations jobs.
*/
public void setExpirationInDays(Integer expirationInDays) {
this.expirationInDays = expirationInDays;
}
/**
*
* This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive object remains available in Amazon S3.
* S3 Initiate Restore Object jobs that target S3 Glacier and S3 Glacier Deep Archive objects require
* ExpirationInDays set to 1 or greater.
*
*
* Conversely, do not set ExpirationInDays when creating S3 Initiate Restore Object jobs that
* target S3 Intelligent-Tiering Archive Access and Deep Archive Access tier objects. Objects in S3
* Intelligent-Tiering archive access tiers are not subject to restore expiry, so specifying
* ExpirationInDays results in restore request failure.
*
*
* S3 Batch Operations jobs can operate either on S3 Glacier and S3 Glacier Deep Archive storage class objects or on
* S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier objects, but not both types in the
* same job. If you need to restore objects of both types you must create separate Batch Operations jobs.
*
*
* @return This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive object remains available in
* Amazon S3. S3 Initiate Restore Object jobs that target S3 Glacier and S3 Glacier Deep Archive objects
* require ExpirationInDays set to 1 or greater.
*
* Conversely, do not set ExpirationInDays when creating S3 Initiate Restore Object jobs
* that target S3 Intelligent-Tiering Archive Access and Deep Archive Access tier objects. Objects in S3
* Intelligent-Tiering archive access tiers are not subject to restore expiry, so specifying
* ExpirationInDays results in restore request failure.
*
*
* S3 Batch Operations jobs can operate either on S3 Glacier and S3 Glacier Deep Archive storage class
* objects or on S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier objects, but not
* both types in the same job. If you need to restore objects of both types you must create separate
* Batch Operations jobs.
*/
public Integer getExpirationInDays() {
return this.expirationInDays;
}
/**
*
* This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive object remains available in Amazon S3.
* S3 Initiate Restore Object jobs that target S3 Glacier and S3 Glacier Deep Archive objects require
* ExpirationInDays set to 1 or greater.
*
*
* Conversely, do not set ExpirationInDays when creating S3 Initiate Restore Object jobs that
* target S3 Intelligent-Tiering Archive Access and Deep Archive Access tier objects. Objects in S3
* Intelligent-Tiering archive access tiers are not subject to restore expiry, so specifying
* ExpirationInDays results in restore request failure.
*
*
* S3 Batch Operations jobs can operate either on S3 Glacier and S3 Glacier Deep Archive storage class objects or on
* S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier objects, but not both types in the
* same job. If you need to restore objects of both types you must create separate Batch Operations jobs.
*
*
* @param expirationInDays
* This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive object remains available in
* Amazon S3. S3 Initiate Restore Object jobs that target S3 Glacier and S3 Glacier Deep Archive objects
* require ExpirationInDays set to 1 or greater.
*
* Conversely, do not set ExpirationInDays when creating S3 Initiate Restore Object jobs
* that target S3 Intelligent-Tiering Archive Access and Deep Archive Access tier objects. Objects in S3
* Intelligent-Tiering archive access tiers are not subject to restore expiry, so specifying
* ExpirationInDays results in restore request failure.
*
*
* S3 Batch Operations jobs can operate either on S3 Glacier and S3 Glacier Deep Archive storage class
* objects or on S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier objects, but not
* both types in the same job. If you need to restore objects of both types you must create separate
* Batch Operations jobs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public S3InitiateRestoreObjectOperation withExpirationInDays(Integer expirationInDays) {
setExpirationInDays(expirationInDays);
return this;
}
/**
*
* S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the
* EXPEDITED retrieval tier.
*
*
* @param glacierJobTier
* S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the
* EXPEDITED retrieval tier.
* @see S3GlacierJobTier
*/
public void setGlacierJobTier(String glacierJobTier) {
this.glacierJobTier = glacierJobTier;
}
/**
*
* S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the
* EXPEDITED retrieval tier.
*
*
* @return S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the
* EXPEDITED retrieval tier.
* @see S3GlacierJobTier
*/
public String getGlacierJobTier() {
return this.glacierJobTier;
}
/**
*
* S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the
* EXPEDITED retrieval tier.
*
*
* @param glacierJobTier
* S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the
* EXPEDITED retrieval tier.
* @return Returns a reference to this object so that method calls can be chained together.
* @see S3GlacierJobTier
*/
public S3InitiateRestoreObjectOperation withGlacierJobTier(String glacierJobTier) {
setGlacierJobTier(glacierJobTier);
return this;
}
/**
*
* S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the
* EXPEDITED retrieval tier.
*
*
* @param glacierJobTier
* S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the
* EXPEDITED retrieval tier.
* @return Returns a reference to this object so that method calls can be chained together.
* @see S3GlacierJobTier
*/
public S3InitiateRestoreObjectOperation withGlacierJobTier(S3GlacierJobTier glacierJobTier) {
this.glacierJobTier = glacierJobTier.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 (getExpirationInDays() != null)
sb.append("ExpirationInDays: ").append(getExpirationInDays()).append(",");
if (getGlacierJobTier() != null)
sb.append("GlacierJobTier: ").append(getGlacierJobTier());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof S3InitiateRestoreObjectOperation == false)
return false;
S3InitiateRestoreObjectOperation other = (S3InitiateRestoreObjectOperation) obj;
if (other.getExpirationInDays() == null ^ this.getExpirationInDays() == null)
return false;
if (other.getExpirationInDays() != null && other.getExpirationInDays().equals(this.getExpirationInDays()) == false)
return false;
if (other.getGlacierJobTier() == null ^ this.getGlacierJobTier() == null)
return false;
if (other.getGlacierJobTier() != null && other.getGlacierJobTier().equals(this.getGlacierJobTier()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getExpirationInDays() == null) ? 0 : getExpirationInDays().hashCode());
hashCode = prime * hashCode + ((getGlacierJobTier() == null) ? 0 : getGlacierJobTier().hashCode());
return hashCode;
}
@Override
public S3InitiateRestoreObjectOperation clone() {
try {
return (S3InitiateRestoreObjectOperation) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}