Class Permission
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Permission.Builder,
Permission>
Permission granted to a user, group, or resource to access a certain aspect of another user, group, or resource mailbox.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Permission.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final String
The identifier of the user, group, or resource to which the permissions are granted.final MemberType
The type of user, group, or resource referred to in GranteeId.final String
The type of user, group, or resource referred to in GranteeId.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the PermissionValues property.final List
<PermissionType> The permissions granted to the grantee.The permissions granted to the grantee.static Class
<? extends Permission.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
granteeId
The identifier of the user, group, or resource to which the permissions are granted.
- Returns:
- The identifier of the user, group, or resource to which the permissions are granted.
-
granteeType
The type of user, group, or resource referred to in GranteeId.
If the service returns an enum value that is not available in the current SDK version,
granteeType
will returnMemberType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromgranteeTypeAsString()
.- Returns:
- The type of user, group, or resource referred to in GranteeId.
- See Also:
-
granteeTypeAsString
The type of user, group, or resource referred to in GranteeId.
If the service returns an enum value that is not available in the current SDK version,
granteeType
will returnMemberType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromgranteeTypeAsString()
.- Returns:
- The type of user, group, or resource referred to in GranteeId.
- See Also:
-
permissionValues
The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasPermissionValues()
method.- Returns:
- The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.
-
hasPermissionValues
public final boolean hasPermissionValues()For responses, this returns true if the service returned a value for the PermissionValues property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
permissionValuesAsStrings
The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasPermissionValues()
method.- Returns:
- The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.
-
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 interfaceToCopyableBuilder<Permission.Builder,
Permission> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-