Package com.amazonaws.services.s3.model
Enum Permission
- java.lang.Object
-
- java.lang.Enum<Permission>
-
- com.amazonaws.services.s3.model.Permission
-
- All Implemented Interfaces:
Serializable
,Comparable<Permission>
public enum Permission extends Enum<Permission>
Specifies constants defining an access permission, as granted to grantees in anAccessControlList
. Only a limited set of permission are available; each one is represented as a value in this enumeration.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description FullControl
Provides READ, WRITE, READ_ACP, and WRITE_ACP permissions.Read
Grants permission to list the bucket when applied to a bucket.ReadAcp
Grants permission to read the ACL for the applicable bucket or object.Write
Grants permission to create, overwrite, and delete any objects in the bucket.WriteAcp
Gives permission to overwrite the ACP for the applicable bucket or object.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getHeaderName()
Returns the name of the header used to grant this permission.static Permission
parsePermission(String str)
Returns thePermission
enumeration value representing the specified Amazon S3 Region ID string.String
toString()
Gets the string representation of this permission object as defined by Amazon S3, eg.static Permission
valueOf(String name)
Returns the enum constant of this type with the specified name.static Permission[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
FullControl
public static final Permission FullControl
Provides READ, WRITE, READ_ACP, and WRITE_ACP permissions.It does not convey additional rights and is provided only for convenience.
-
Read
public static final Permission Read
Grants permission to list the bucket when applied to a bucket. Grants permission to read object data and/or metadata when applied to an object.
-
Write
public static final Permission Write
Grants permission to create, overwrite, and delete any objects in the bucket.This permission is not supported for objects.
-
ReadAcp
public static final Permission ReadAcp
Grants permission to read the ACL for the applicable bucket or object.The owner of a bucket or object always implicitly has this permission.
-
WriteAcp
public static final Permission WriteAcp
Gives permission to overwrite the ACP for the applicable bucket or object.The owner of a bucket or object always has this permission implicitly.
Granting this permission is equivalent to granting
FULL_CONTROL
because the grant recipient can make any changes to the ACP.
-
-
Method Detail
-
values
public static Permission[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (Permission c : Permission.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static Permission 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 nameNullPointerException
- if the argument is null
-
getHeaderName
public String getHeaderName()
Returns the name of the header used to grant this permission.
-
toString
public String toString()
Gets the string representation of this permission object as defined by Amazon S3, eg.FULL_CONTROL
.- Overrides:
toString
in classEnum<Permission>
- Returns:
- The string representation of this permission object as defined by
Amazon S3, eg.
FULL_CONTROL
.
-
parsePermission
public static Permission parsePermission(String str)
Returns thePermission
enumeration value representing the specified Amazon S3 Region ID string. If specified string doesn't map to a known Amazon S3 Region, returnsnull
.- Parameters:
str
- A string representation of an Amazon S3 permission, eg.FULL_CONTROL
- Returns:
- The
Permission
object represented by the given permission string, Returnsnull
if the string isn't a valid representation of an Amazon S3 permission.
-
-