software.amazon.awssdk.services.s3control.model.CreateBucketResponse Maven / Gradle / Ivy
/*
* Copyright 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 software.amazon.awssdk.services.s3control.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateBucketResponse extends S3ControlResponse implements
ToCopyableBuilder {
private static final SdkField LOCATION_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("Location")
.getter(getter(CreateBucketResponse::location))
.setter(setter(Builder::location))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("Location")
.unmarshallLocationName("Location").build()).build();
private static final SdkField BUCKET_ARN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("BucketArn")
.getter(getter(CreateBucketResponse::bucketArn))
.setter(setter(Builder::bucketArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("BucketArn")
.unmarshallLocationName("BucketArn").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(LOCATION_FIELD,
BUCKET_ARN_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final String location;
private final String bucketArn;
private CreateBucketResponse(BuilderImpl builder) {
super(builder);
this.location = builder.location;
this.bucketArn = builder.bucketArn;
}
/**
*
* The location of the bucket.
*
*
* @return The location of the bucket.
*/
public final String location() {
return 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.
*
*
* @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 final String bucketArn() {
return bucketArn;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(location());
hashCode = 31 * hashCode + Objects.hashCode(bucketArn());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateBucketResponse)) {
return false;
}
CreateBucketResponse other = (CreateBucketResponse) obj;
return Objects.equals(location(), other.location()) && Objects.equals(bucketArn(), other.bucketArn());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("CreateBucketResponse").add("Location", location()).add("BucketArn", bucketArn()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Location":
return Optional.ofNullable(clazz.cast(location()));
case "BucketArn":
return Optional.ofNullable(clazz.cast(bucketArn()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("Location", LOCATION_FIELD);
map.put("BucketArn", BUCKET_ARN_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((CreateBucketResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends S3ControlResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* 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.
*/
Builder location(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.
*
*
* @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.
*/
Builder bucketArn(String bucketArn);
}
static final class BuilderImpl extends S3ControlResponse.BuilderImpl implements Builder {
private String location;
private String bucketArn;
private BuilderImpl() {
}
private BuilderImpl(CreateBucketResponse model) {
super(model);
location(model.location);
bucketArn(model.bucketArn);
}
public final String getLocation() {
return location;
}
public final void setLocation(String location) {
this.location = location;
}
@Override
public final Builder location(String location) {
this.location = location;
return this;
}
public final String getBucketArn() {
return bucketArn;
}
public final void setBucketArn(String bucketArn) {
this.bucketArn = bucketArn;
}
@Override
public final Builder bucketArn(String bucketArn) {
this.bucketArn = bucketArn;
return this;
}
@Override
public CreateBucketResponse build() {
return new CreateBucketResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}