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:

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Bucket.Builder,Bucket>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.