Enum RequestPayer

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

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

  • Enum Constant Details

    • REQUESTER

      public static final RequestPayer REQUESTER

    • UNKNOWN_TO_SDK_VERSION

      public static final RequestPayer UNKNOWN_TO_SDK_VERSION

  • Method Details

    • values

      public static RequestPayer[] 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 RequestPayer 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<RequestPayer>

    • fromValue

      public static RequestPayer 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:
      RequestPayer corresponding to the value

    • knownValues

      public static Set<RequestPayer> 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 RequestPayers