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

Class Bucket

java.lang.Object

software.amazon.awssdk.services.s3.model.Bucket

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Bucket.Builder,Bucket>

@Generated("software.amazon.awssdk:codegen")
public final class Bucket
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Bucket.Builder,Bucket>

In terms of implementation, a Bucket is a resource.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Bucket.Builder

Method Summary

Modifier and Type	Method	Description
String	bucketArn()	The Amazon Resource Name (ARN) of the S3 bucket.
String	bucketRegion()	BucketRegion indicates the Amazon Web Services region where the bucket is located.
static Bucket.Builder	builder()
Instant	creationDate()	Date the bucket was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the bucket.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Bucket.Builder>	serializableBuilderClass()
Bucket.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

name

public final String name()

The name of the bucket.

Returns:

The name of the bucket.

creationDate

public final Instant creationDate()

Date the bucket was created. This date can change when making changes to your bucket, such as editing its bucket policy.

Returns:

Date the bucket was created. This date can change when making changes to your bucket, such as editing its bucket policy.

bucketRegion

public final String bucketRegion()

BucketRegion indicates the Amazon Web Services region where the bucket is located. If the request contains at least one valid parameter, it is included in the response.

Returns:

BucketRegion indicates the Amazon Web Services region where the bucket is located. If the request contains at least one valid parameter, it is included in the response.

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.

toBuilder

public Bucket.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Bucket.Builder,Bucket>

builder

public static Bucket.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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