Enum EncodingType

java.lang.Object
java.lang.Enum<EncodingType>
software.amazon.awssdk.services.s3.model.EncodingType
All Implemented Interfaces:
Serializable, Comparable<EncodingType>
@Generated("software.amazon.awssdk:codegen") public enum EncodingType extends Enum<EncodingType>

Encoding type used by Amazon S3 to encode the object keys in the response. Responses are encoded only in UTF-8. An object key can contain any Unicode character. However, the XML 1.0 parser can't parse certain characters, such as characters with an ASCII value from 0 to 10. For characters that aren't supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. For more information about characters to avoid in object key names, see Object key naming guidelines.

When using the URL encoding type, non-ASCII characters that are used in an object's key name will be percent-encoded according to UTF-8 code values. For example, the object test_file(3).png will appear as test_file%283%29.png.

  • Enum Constant Details

    • URL

      public static final EncodingType URL

    • UNKNOWN_TO_SDK_VERSION

      public static final EncodingType UNKNOWN_TO_SDK_VERSION

  • Method Details

    • values

      public static EncodingType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static EncodingType valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • toString

      public String toString()
      Overrides:
      toString in class Enum<EncodingType>

    • fromValue

      public static EncodingType fromValue(String value)
      Use this in place of valueOf to convert the raw string returned by the service into the enum value.
      Parameters:
      value - real value
      Returns:
      EncodingType corresponding to the value

    • knownValues

      public static Set<EncodingType> knownValues()
      Use this in place of values() to return a Set of all values known to the SDK. This will return all known enum values except UNKNOWN_TO_SDK_VERSION.
      Returns:
      a Set of known EncodingTypes