com.amazonaws.services.s3control.model.CreateBucketResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-s3control Show documentation
/*
* Copyright 2017-2022 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;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateBucketResult extends com.amazonaws.AmazonWebServiceResult implements
Serializable, Cloneable {
/**
*
* The location of the bucket.
*
*/
private String location;
/**
*
* The Amazon Resource Name (ARN) of the bucket.
*
*
* For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the
* x-amz-outpost-id as well.
*
*
* For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN
* of the bucket accessed in the format
* arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
* . For example, to access the bucket reports through outpost my-outpost owned by account
* 123456789012 in Region us-west-2, use the URL encoding of
* arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
* encoded.
*
*/
private String bucketArn;
/**
*
* The location of the bucket.
*
*
* @param location
* The location of the bucket.
*/
public void setLocation(String location) {
this.location = location;
}
/**
*
* The location of the bucket.
*
*
* @return The location of the bucket.
*/
public String getLocation() {
return this.location;
}
/**
*
* The location of the bucket.
*
*
* @param location
* The location of the bucket.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateBucketResult withLocation(String location) {
setLocation(location);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the bucket.
*
*
* For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the
* x-amz-outpost-id as well.
*
*
* For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN
* of the bucket accessed in the format
* arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
* . For example, to access the bucket reports through outpost my-outpost owned by account
* 123456789012 in Region us-west-2, use the URL encoding of
* arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
* encoded.
*
*
* @param bucketArn
* The Amazon Resource Name (ARN) of the bucket.
*
* For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the
* x-amz-outpost-id as well.
*
*
* For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify
* the ARN of the bucket accessed in the format
* arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
* . For example, to access the bucket reports through outpost my-outpost owned by
* account 123456789012 in Region us-west-2, use the URL encoding of
* arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must
* be URL encoded.
*/
public void setBucketArn(String bucketArn) {
this.bucketArn = bucketArn;
}
/**
*
* The Amazon Resource Name (ARN) of the bucket.
*
*
* For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the
* x-amz-outpost-id as well.
*
*
* For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN
* of the bucket accessed in the format
* arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
* . For example, to access the bucket reports through outpost my-outpost owned by account
* 123456789012 in Region us-west-2, use the URL encoding of
* arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
* encoded.
*
*
* @return The Amazon Resource Name (ARN) of the bucket.
*
* For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the
* x-amz-outpost-id as well.
*
*
* For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify
* the ARN of the bucket accessed in the format
* arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
* . For example, to access the bucket reports through outpost my-outpost owned by
* account 123456789012 in Region us-west-2, use the URL encoding of
* arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must
* be URL encoded.
*/
public String getBucketArn() {
return this.bucketArn;
}
/**
*
* The Amazon Resource Name (ARN) of the bucket.
*
*
* For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the
* x-amz-outpost-id as well.
*
*
* For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN
* of the bucket accessed in the format
* arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
* . For example, to access the bucket reports through outpost my-outpost owned by account
* 123456789012 in Region us-west-2, use the URL encoding of
* arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
* encoded.
*
*
* @param bucketArn
* The Amazon Resource Name (ARN) of the bucket.
*
* For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the
* x-amz-outpost-id as well.
*
*
* For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify
* the ARN of the bucket accessed in the format
* arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
* . For example, to access the bucket reports through outpost my-outpost owned by
* account 123456789012 in Region us-west-2, use the URL encoding of
* arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must
* be URL encoded.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateBucketResult withBucketArn(String bucketArn) {
setBucketArn(bucketArn);
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 (getLocation() != null)
sb.append("Location: ").append(getLocation()).append(",");
if (getBucketArn() != null)
sb.append("BucketArn: ").append(getBucketArn());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateBucketResult == false)
return false;
CreateBucketResult other = (CreateBucketResult) obj;
if (other.getLocation() == null ^ this.getLocation() == null)
return false;
if (other.getLocation() != null && other.getLocation().equals(this.getLocation()) == false)
return false;
if (other.getBucketArn() == null ^ this.getBucketArn() == null)
return false;
if (other.getBucketArn() != null && other.getBucketArn().equals(this.getBucketArn()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getLocation() == null) ? 0 : getLocation().hashCode());
hashCode = prime * hashCode + ((getBucketArn() == null) ? 0 : getBucketArn().hashCode());
return hashCode;
}
@Override
public CreateBucketResult clone() {
try {
return (CreateBucketResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}