Package software.amazon.awssdk.services.s3.model

Class HeadBucketResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.s3.model.S3Response

software.amazon.awssdk.services.s3.model.HeadBucketResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<HeadBucketResponse.Builder,HeadBucketResponse>

@Generated("software.amazon.awssdk:codegen")
public final class HeadBucketResponse
extends S3Response
implements ToCopyableBuilder<HeadBucketResponse.Builder,HeadBucketResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HeadBucketResponse.Builder

Method Summary

Modifier and Type	Method	Description
Boolean	accessPointAlias()	Indicates whether the bucket name used in the request is an access point alias.
String	bucketArn()	The Amazon Resource Name (ARN) of the S3 bucket.
String	bucketLocationName()	The name of the location where the bucket will be created.
LocationType	bucketLocationType()	The type of location where the bucket is created.
String	bucketLocationTypeAsString()	The type of location where the bucket is created.
String	bucketRegion()	The Region that the bucket is located.
static HeadBucketResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends HeadBucketResponse.Builder>	serializableBuilderClass()
HeadBucketResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.s3.model.S3Response

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

bucketArn

public final String bucketArn()

The Amazon Resource Name (ARN) of the S3 bucket. ARNs uniquely identify Amazon Web Services resources across all of Amazon Web Services.

This parameter is only supported for S3 directory buckets. For more information, see Using tags with directory buckets.

Returns:

The Amazon Resource Name (ARN) of the S3 bucket. ARNs uniquely identify Amazon Web Services resources across all of Amazon Web Services.

This parameter is only supported for S3 directory buckets. For more information, see Using tags with directory buckets.

bucketLocationType

public final LocationType bucketLocationType()

The type of location where the bucket is created.

This functionality is only supported by directory buckets.

If the service returns an enum value that is not available in the current SDK version, bucketLocationType will return LocationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from bucketLocationTypeAsString().

Returns:

The type of location where the bucket is created.

This functionality is only supported by directory buckets.

See Also:

LocationType

bucketLocationTypeAsString

public final String bucketLocationTypeAsString()

The type of location where the bucket is created.

This functionality is only supported by directory buckets.

If the service returns an enum value that is not available in the current SDK version, bucketLocationType will return LocationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from bucketLocationTypeAsString().

Returns:

The type of location where the bucket is created.

This functionality is only supported by directory buckets.

See Also:

LocationType

bucketLocationName

public final String bucketLocationName()

The name of the location where the bucket will be created.

For directory buckets, the Zone ID of the Availability Zone or the Local Zone where the bucket is created. An example Zone ID value for an Availability Zone is usw2-az1.

This functionality is only supported by directory buckets.

Returns:

The name of the location where the bucket will be created.

For directory buckets, the Zone ID of the Availability Zone or the Local Zone where the bucket is created. An example Zone ID value for an Availability Zone is usw2-az1.

This functionality is only supported by directory buckets.

bucketRegion

public final String bucketRegion()

The Region that the bucket is located.

Returns:

The Region that the bucket is located.

accessPointAlias

public final Boolean accessPointAlias()

Indicates whether the bucket name used in the request is an access point alias.

For directory buckets, the value of this field is false.

Returns:

Indicates whether the bucket name used in the request is an access point alias.

For directory buckets, the value of this field is false.

toBuilder

public HeadBucketResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<HeadBucketResponse.Builder,HeadBucketResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static HeadBucketResponse.Builder builder()

serializableBuilderClass

public static Class<? extends HeadBucketResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo