com.amazonaws.services.iot.model.S3Action Maven / Gradle / Ivy
Show all versions of aws-android-sdk-iot Show documentation
/*
* Copyright 2010-2018 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.iot.model;
import java.io.Serializable;
/**
*
* Describes an action to write data to an Amazon S3 bucket.
*
*/
public class S3Action implements Serializable {
/**
*
* The ARN of the IAM role that grants access.
*
*/
private String roleArn;
/**
*
* The Amazon S3 bucket.
*
*/
private String bucketName;
/**
*
* The object key.
*
*/
private String key;
/**
*
* The Amazon S3 canned ACL that controls access to the object identified by
* the object key. For more information, see S3 canned ACLs.
*
*
* Constraints:
* Allowed Values: private, public-read, public-read-write,
* aws-exec-read, authenticated-read, bucket-owner-read,
* bucket-owner-full-control, log-delivery-write
*/
private String cannedAcl;
/**
*
* The ARN of the IAM role that grants access.
*
*
* @return
* The ARN of the IAM role that grants access.
*
*/
public String getRoleArn() {
return roleArn;
}
/**
*
* The ARN of the IAM role that grants access.
*
*
* @param roleArn
* The ARN of the IAM role that grants access.
*
*/
public void setRoleArn(String roleArn) {
this.roleArn = roleArn;
}
/**
*
* The ARN of the IAM role that grants access.
*
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param roleArn
* The ARN of the IAM role that grants access.
*
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public S3Action withRoleArn(String roleArn) {
this.roleArn = roleArn;
return this;
}
/**
*
* The Amazon S3 bucket.
*
*
* @return
* The Amazon S3 bucket.
*
*/
public String getBucketName() {
return bucketName;
}
/**
*
* The Amazon S3 bucket.
*
*
* @param bucketName
* The Amazon S3 bucket.
*
*/
public void setBucketName(String bucketName) {
this.bucketName = bucketName;
}
/**
*
* The Amazon S3 bucket.
*
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param bucketName
* The Amazon S3 bucket.
*
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public S3Action withBucketName(String bucketName) {
this.bucketName = bucketName;
return this;
}
/**
*
* The object key.
*
*
* @return
* The object key.
*
*/
public String getKey() {
return key;
}
/**
*
* The object key.
*
*
* @param key
* The object key.
*
*/
public void setKey(String key) {
this.key = key;
}
/**
*
* The object key.
*
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param key
* The object key.
*
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public S3Action withKey(String key) {
this.key = key;
return this;
}
/**
*
* The Amazon S3 canned ACL that controls access to the object identified by
* the object key. For more information, see S3 canned ACLs.
*
*
* Constraints:
* Allowed Values: private, public-read, public-read-write,
* aws-exec-read, authenticated-read, bucket-owner-read,
* bucket-owner-full-control, log-delivery-write
*
* @return
* The Amazon S3 canned ACL that controls access to the object
* identified by the object key. For more information, see S3 canned ACLs.
*
* @see CannedAccessControlList
*/
public String getCannedAcl() {
return cannedAcl;
}
/**
*
* The Amazon S3 canned ACL that controls access to the object identified by
* the object key. For more information, see S3 canned ACLs.
*
*
* Constraints:
* Allowed Values: private, public-read, public-read-write,
* aws-exec-read, authenticated-read, bucket-owner-read,
* bucket-owner-full-control, log-delivery-write
*
* @param cannedAcl
* The Amazon S3 canned ACL that controls access to the object
* identified by the object key. For more information, see S3 canned ACLs.
*
* @see CannedAccessControlList
*/
public void setCannedAcl(String cannedAcl) {
this.cannedAcl = cannedAcl;
}
/**
*
* The Amazon S3 canned ACL that controls access to the object identified by
* the object key. For more information, see S3 canned ACLs.
*
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* Constraints:
* Allowed Values: private, public-read, public-read-write,
* aws-exec-read, authenticated-read, bucket-owner-read,
* bucket-owner-full-control, log-delivery-write
*
* @param cannedAcl
* The Amazon S3 canned ACL that controls access to the object
* identified by the object key. For more information, see S3 canned ACLs.
*
* @return A reference to this updated object so that method calls can be
* chained together.
* @see CannedAccessControlList
*/
public S3Action withCannedAcl(String cannedAcl) {
this.cannedAcl = cannedAcl;
return this;
}
/**
*
* The Amazon S3 canned ACL that controls access to the object identified by
* the object key. For more information, see S3 canned ACLs.
*
*
* Constraints:
* Allowed Values: private, public-read, public-read-write,
* aws-exec-read, authenticated-read, bucket-owner-read,
* bucket-owner-full-control, log-delivery-write
*
* @param cannedAcl
* The Amazon S3 canned ACL that controls access to the object
* identified by the object key. For more information, see S3 canned ACLs.
*
* @see CannedAccessControlList
*/
public void setCannedAcl(CannedAccessControlList cannedAcl) {
this.cannedAcl = cannedAcl.toString();
}
/**
*
* The Amazon S3 canned ACL that controls access to the object identified by
* the object key. For more information, see S3 canned ACLs.
*
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* Constraints:
* Allowed Values: private, public-read, public-read-write,
* aws-exec-read, authenticated-read, bucket-owner-read,
* bucket-owner-full-control, log-delivery-write
*
* @param cannedAcl
* The Amazon S3 canned ACL that controls access to the object
* identified by the object key. For more information, see S3 canned ACLs.
*
* @return A reference to this updated object so that method calls can be
* chained together.
* @see CannedAccessControlList
*/
public S3Action withCannedAcl(CannedAccessControlList cannedAcl) {
this.cannedAcl = cannedAcl.toString();
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 (getRoleArn() != null)
sb.append("roleArn: " + getRoleArn() + ",");
if (getBucketName() != null)
sb.append("bucketName: " + getBucketName() + ",");
if (getKey() != null)
sb.append("key: " + getKey() + ",");
if (getCannedAcl() != null)
sb.append("cannedAcl: " + getCannedAcl());
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getRoleArn() == null) ? 0 : getRoleArn().hashCode());
hashCode = prime * hashCode + ((getBucketName() == null) ? 0 : getBucketName().hashCode());
hashCode = prime * hashCode + ((getKey() == null) ? 0 : getKey().hashCode());
hashCode = prime * hashCode + ((getCannedAcl() == null) ? 0 : getCannedAcl().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof S3Action == false)
return false;
S3Action other = (S3Action) obj;
if (other.getRoleArn() == null ^ this.getRoleArn() == null)
return false;
if (other.getRoleArn() != null && other.getRoleArn().equals(this.getRoleArn()) == false)
return false;
if (other.getBucketName() == null ^ this.getBucketName() == null)
return false;
if (other.getBucketName() != null
&& other.getBucketName().equals(this.getBucketName()) == false)
return false;
if (other.getKey() == null ^ this.getKey() == null)
return false;
if (other.getKey() != null && other.getKey().equals(this.getKey()) == false)
return false;
if (other.getCannedAcl() == null ^ this.getCannedAcl() == null)
return false;
if (other.getCannedAcl() != null
&& other.getCannedAcl().equals(this.getCannedAcl()) == false)
return false;
return true;
}
}