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

Class Grantee

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

Container for the person being granted permissions.

See Also:

  • Method Details

    • displayName

      public final String displayName()

      Screen name of the grantee.

      Returns:
      Screen name of the grantee.

    • emailAddress

      public final String emailAddress()

      Email address of the grantee.

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      • US East (N. Virginia)

      • US West (N. California)

      • US West (Oregon)

      • Asia Pacific (Singapore)

      • Asia Pacific (Sydney)

      • Asia Pacific (Tokyo)

      • Europe (Ireland)

      • South America (São Paulo)

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

      Returns:
      Email address of the grantee.

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      • US East (N. Virginia)

      • US West (N. California)

      • US West (Oregon)

      • Asia Pacific (Singapore)

      • Asia Pacific (Sydney)

      • Asia Pacific (Tokyo)

      • Europe (Ireland)

      • South America (São Paulo)

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    • id

      public final String id()

      The canonical user ID of the grantee.

      Returns:
      The canonical user ID of the grantee.

    • type

      public final Type type()

      Type of grantee

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

      Returns:
      Type of grantee
      See Also:

    • typeAsString

      public final String typeAsString()

      Type of grantee

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

      Returns:
      Type of grantee
      See Also:

    • uri

      public final String uri()

      URI of the grantee group.

      Returns:
      URI of the grantee group.

    • toBuilder

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

    • builder

      public static Grantee.Builder builder()

    • serializableBuilderClass

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