software.amazon.awssdk.services.s3.model.HeadBucketRequest Maven / Gradle / Ivy
Show all versions of s3 Show documentation
/*
* 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.s3.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
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 HeadBucketRequest extends S3Request implements ToCopyableBuilder {
private static final SdkField BUCKET_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("Bucket")
.getter(getter(HeadBucketRequest::bucket))
.setter(setter(Builder::bucket))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("Bucket")
.unmarshallLocationName("Bucket").build()).build();
private static final SdkField EXPECTED_BUCKET_OWNER_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ExpectedBucketOwner")
.getter(getter(HeadBucketRequest::expectedBucketOwner))
.setter(setter(Builder::expectedBucketOwner))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-expected-bucket-owner")
.unmarshallLocationName("x-amz-expected-bucket-owner").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(BUCKET_FIELD,
EXPECTED_BUCKET_OWNER_FIELD));
private final String bucket;
private final String expectedBucketOwner;
private HeadBucketRequest(BuilderImpl builder) {
super(builder);
this.bucket = builder.bucket;
this.expectedBucketOwner = builder.expectedBucketOwner;
}
/**
*
* The bucket name.
*
*
* When using this API with an access point, you must direct requests to the access point hostname. The access point
* hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When
* using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the
* bucket name. For more information about access point ARNs, see Using Access Points in the
* Amazon Simple Storage Service Developer Guide.
*
*
* When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3
* on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this
* operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket
* name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the
* Amazon Simple Storage Service Developer Guide.
*
*
* @return The bucket name.
*
* When using this API with an access point, you must direct requests to the access point hostname. The
* access point hostname takes the form
* AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this
* operation with an access point through the AWS SDKs, you provide the access point ARN in place of the
* bucket name. For more information about access point ARNs, see Using Access Points
* in the Amazon Simple Storage Service Developer Guide.
*
*
* When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname.
* The S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When
* using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in
* place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the
* Amazon Simple Storage Service Developer Guide.
*/
public String bucket() {
return bucket;
}
/**
*
* The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail
* with an HTTP 403 (Access Denied) error.
*
*
* @return The account id of the expected bucket owner. If the bucket is owned by a different account, the request
* will fail with an HTTP 403 (Access Denied) error.
*/
public String expectedBucketOwner() {
return expectedBucketOwner;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(bucket());
hashCode = 31 * hashCode + Objects.hashCode(expectedBucketOwner());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof HeadBucketRequest)) {
return false;
}
HeadBucketRequest other = (HeadBucketRequest) obj;
return Objects.equals(bucket(), other.bucket()) && Objects.equals(expectedBucketOwner(), other.expectedBucketOwner());
}
/**
* 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 String toString() {
return ToString.builder("HeadBucketRequest").add("Bucket", bucket()).add("ExpectedBucketOwner", expectedBucketOwner())
.build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Bucket":
return Optional.ofNullable(clazz.cast(bucket()));
case "ExpectedBucketOwner":
return Optional.ofNullable(clazz.cast(expectedBucketOwner()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((HeadBucketRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends S3Request.Builder, SdkPojo, CopyableBuilder {
/**
*
* The bucket name.
*
*
* When using this API with an access point, you must direct requests to the access point hostname. The access
* point hostname takes the form
* AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation
* with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For
* more information about access point ARNs, see Using Access Points in
* the Amazon Simple Storage Service Developer Guide.
*
*
* When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The
* S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using
* this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the
* bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the
* Amazon Simple Storage Service Developer Guide.
*
*
* @param bucket
* The bucket name.
*
* When using this API with an access point, you must direct requests to the access point hostname. The
* access point hostname takes the form
* AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this
* operation with an access point through the AWS SDKs, you provide the access point ARN in place of the
* bucket name. For more information about access point ARNs, see Using Access
* Points in the Amazon Simple Storage Service Developer Guide.
*
*
* When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts
* hostname. The S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When
* using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in
* place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in
* the Amazon Simple Storage Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder bucket(String bucket);
/**
*
* The account id of the expected bucket owner. If the bucket is owned by a different account, the request will
* fail with an HTTP 403 (Access Denied) error.
*
*
* @param expectedBucketOwner
* The account id of the expected bucket owner. If the bucket is owned by a different account, the
* request will fail with an HTTP 403 (Access Denied) error.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder expectedBucketOwner(String expectedBucketOwner);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends S3Request.BuilderImpl implements Builder {
private String bucket;
private String expectedBucketOwner;
private BuilderImpl() {
}
private BuilderImpl(HeadBucketRequest model) {
super(model);
bucket(model.bucket);
expectedBucketOwner(model.expectedBucketOwner);
}
public final String getBucket() {
return bucket;
}
@Override
public final Builder bucket(String bucket) {
this.bucket = bucket;
return this;
}
public final void setBucket(String bucket) {
this.bucket = bucket;
}
public final String getExpectedBucketOwner() {
return expectedBucketOwner;
}
@Override
public final Builder expectedBucketOwner(String expectedBucketOwner) {
this.expectedBucketOwner = expectedBucketOwner;
return this;
}
public final void setExpectedBucketOwner(String expectedBucketOwner) {
this.expectedBucketOwner = expectedBucketOwner;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public HeadBucketRequest build() {
return new HeadBucketRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}