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

Class LocationInfo

java.lang.Object
software.amazon.awssdk.services.s3.model.LocationInfo
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<LocationInfo.Builder,LocationInfo>
@Generated("software.amazon.awssdk:codegen") public final class LocationInfo extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LocationInfo.Builder,LocationInfo>

Specifies the location where the bucket will be created.

For directory buckets, the location type is Availability Zone. For more information about directory buckets, see Directory buckets in the Amazon S3 User Guide.

This functionality is only supported by directory buckets.

See Also:

  • Method Details

    • type

      public final LocationType type()

      The type of location where the bucket will be created.

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

      Returns:
      The type of location where the bucket will be created.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of location where the bucket will be created.

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

      Returns:
      The type of location where the bucket will be created.
      See Also:

    • name

      public final String name()

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

      For directory buckets, the name of the location is the AZ ID of the Availability Zone where the bucket will be created. An example AZ ID value is usw2-az1.

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

      For directory buckets, the name of the location is the AZ ID of the Availability Zone where the bucket will be created. An example AZ ID value is usw2-az1.

    • toBuilder

      public LocationInfo.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<LocationInfo.Builder,LocationInfo>
      Returns:
      a builder for type T

    • builder

      public static LocationInfo.Builder builder()

    • serializableBuilderClass

      public static Class<? extends LocationInfo.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.