com.amazonaws.services.s3

Class S3BucketResource

java.lang.Object

com.amazonaws.services.s3.S3BucketResource

All Implemented Interfaces:

AwsResource, S3Resource

public final class S3BucketResource
extends Object
implements S3Resource

An S3Resource that represents an S3 bucket.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	S3BucketResource.Builder A builder for S3BucketResource objects.

Method Summary

Modifier and Type	Method and Description
static S3BucketResource.Builder	builder() Get a new builder for this class.
boolean	equals(Object o)
String	getAccountId() Gets the AWS account ID associated with this bucket.
String	getBucketName() Gets the name of the bucket.
S3Resource	getParentS3Resource() Gets the optional parent resource.
String	getPartition() Gets the AWS partition name associated with this bucket (e.g.: 'aws').
String	getRegion() Gets the AWS region name associated with this bucket (e.g.: 'us-east-1').
String	getType() Gets the resource type for this bucket.
int	hashCode()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static S3BucketResource.Builder builder()

Get a new builder for this class.

Returns:

A newly initialized instance of a builder.

getType

public String getType()

Gets the resource type for this bucket.

Specified by:

getType in interface S3Resource

Returns:

This will always return "bucket_name".

getParentS3Resource

public S3Resource getParentS3Resource()

Description copied from interface: S3Resource

Gets the optional parent resource.

Specified by:

getParentS3Resource in interface S3Resource

Returns:

the parent resource if exists otherwise null

getPartition

public String getPartition()

Gets the AWS partition name associated with this bucket (e.g.: 'aws').

Specified by:

getPartition in interface AwsResource

Returns:

the name of the partition.

getRegion

public String getRegion()

Gets the AWS region name associated with this bucket (e.g.: 'us-east-1').

Specified by:

getRegion in interface AwsResource

Returns:

the name of the region or null if the region has not been specified (e.g. the resource is in the global namespace).

getAccountId

public String getAccountId()

Gets the AWS account ID associated with this bucket.

Specified by:

getAccountId in interface AwsResource

Returns:

the AWS account ID or null if the account ID has not been specified.

getBucketName

public String getBucketName()

Gets the name of the bucket.

Returns:

the name of the bucket.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object