com.amazonaws.services.snowball.model.S3Resource Maven / Gradle / Ivy
Show all versions of aws-java-sdk-snowball Show documentation
/*
* Copyright 2011-2016 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.snowball.model;
import java.io.Serializable;
/**
*
* Each S3Resource object represents an Amazon S3 bucket that your
* transferred data will be exported from or imported into. For export jobs,
* this object can have an optional KeyRange value. The length of
* the range is defined at job creation, and has either an inclusive
* BeginMarker, an inclusive EndMarker, or both.
* Ranges are UTF-8 binary sorted.
*
*/
public class S3Resource implements Serializable, Cloneable {
/**
*
* The Amazon Resource Name (ARN) of an Amazon S3 bucket.
*
*/
private String bucketArn;
/**
*
* For export jobs, you can provide an optional KeyRange within
* a specific Amazon S3 bucket. The length of the range is defined at job
* creation, and has either an inclusive BeginMarker, an
* inclusive EndMarker, or both. Ranges are UTF-8 binary
* sorted.
*
*/
private KeyRange keyRange;
/**
*
* The Amazon Resource Name (ARN) of an Amazon S3 bucket.
*
*
* @param bucketArn
* The Amazon Resource Name (ARN) of an Amazon S3 bucket.
*/
public void setBucketArn(String bucketArn) {
this.bucketArn = bucketArn;
}
/**
*
* The Amazon Resource Name (ARN) of an Amazon S3 bucket.
*
*
* @return The Amazon Resource Name (ARN) of an Amazon S3 bucket.
*/
public String getBucketArn() {
return this.bucketArn;
}
/**
*
* The Amazon Resource Name (ARN) of an Amazon S3 bucket.
*
*
* @param bucketArn
* The Amazon Resource Name (ARN) of an Amazon S3 bucket.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public S3Resource withBucketArn(String bucketArn) {
setBucketArn(bucketArn);
return this;
}
/**
*
* For export jobs, you can provide an optional KeyRange within
* a specific Amazon S3 bucket. The length of the range is defined at job
* creation, and has either an inclusive BeginMarker, an
* inclusive EndMarker, or both. Ranges are UTF-8 binary
* sorted.
*
*
* @param keyRange
* For export jobs, you can provide an optional KeyRange
* within a specific Amazon S3 bucket. The length of the range is
* defined at job creation, and has either an inclusive
* BeginMarker, an inclusive EndMarker, or
* both. Ranges are UTF-8 binary sorted.
*/
public void setKeyRange(KeyRange keyRange) {
this.keyRange = keyRange;
}
/**
*
* For export jobs, you can provide an optional KeyRange within
* a specific Amazon S3 bucket. The length of the range is defined at job
* creation, and has either an inclusive BeginMarker, an
* inclusive EndMarker, or both. Ranges are UTF-8 binary
* sorted.
*
*
* @return For export jobs, you can provide an optional
* KeyRange within a specific Amazon S3 bucket. The
* length of the range is defined at job creation, and has either an
* inclusive BeginMarker, an inclusive
* EndMarker, or both. Ranges are UTF-8 binary sorted.
*/
public KeyRange getKeyRange() {
return this.keyRange;
}
/**
*
* For export jobs, you can provide an optional KeyRange within
* a specific Amazon S3 bucket. The length of the range is defined at job
* creation, and has either an inclusive BeginMarker, an
* inclusive EndMarker, or both. Ranges are UTF-8 binary
* sorted.
*
*
* @param keyRange
* For export jobs, you can provide an optional KeyRange
* within a specific Amazon S3 bucket. The length of the range is
* defined at job creation, and has either an inclusive
* BeginMarker, an inclusive EndMarker, or
* both. Ranges are UTF-8 binary sorted.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public S3Resource withKeyRange(KeyRange keyRange) {
setKeyRange(keyRange);
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getBucketArn() != null)
sb.append("BucketArn: " + getBucketArn() + ",");
if (getKeyRange() != null)
sb.append("KeyRange: " + getKeyRange());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof S3Resource == false)
return false;
S3Resource other = (S3Resource) obj;
if (other.getBucketArn() == null ^ this.getBucketArn() == null)
return false;
if (other.getBucketArn() != null
&& other.getBucketArn().equals(this.getBucketArn()) == false)
return false;
if (other.getKeyRange() == null ^ this.getKeyRange() == null)
return false;
if (other.getKeyRange() != null
&& other.getKeyRange().equals(this.getKeyRange()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode
+ ((getBucketArn() == null) ? 0 : getBucketArn().hashCode());
hashCode = prime * hashCode
+ ((getKeyRange() == null) ? 0 : getKeyRange().hashCode());
return hashCode;
}
@Override
public S3Resource clone() {
try {
return (S3Resource) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException(
"Got a CloneNotSupportedException from Object.clone() "
+ "even though we're Cloneable!", e);
}
}
}