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>

  • Method Details

    • 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:

    • 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:

    • 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()
      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<HeadBucketResponse.Builder,HeadBucketResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.