software.amazon.awssdk.services.workmail.model

Class Permission

java.lang.Object

software.amazon.awssdk.services.workmail.model.Permission

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Permission.Builder,Permission>

@Generated(value="software.amazon.awssdk:codegen")
public final class Permission
extends Object
implements SdkPojo, Serializable, 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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Permission.Builder

Method Summary

Modifier and Type	Method and Description
static Permission.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	granteeId() The identifier of the user, group, or resource to which the permissions are granted.
MemberType	granteeType() The type of user, group, or resource referred to in GranteeId.
String	granteeTypeAsString() The type of user, group, or resource referred to in GranteeId.
int	hashCode()
boolean	hasPermissionValues() For responses, this returns true if the service returned a value for the PermissionValues property.
List<PermissionType>	permissionValues() The permissions granted to the grantee.
List<String>	permissionValuesAsStrings() The permissions granted to the grantee.
List<SdkField<?>>	sdkFields()
static Class<? extends Permission.Builder>	serializableBuilderClass()
Permission.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

granteeId

public final String 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

public final MemberType 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 return MemberType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from granteeTypeAsString().

Returns:

The type of user, group, or resource referred to in GranteeId.

See Also:

MemberType

granteeTypeAsString

public final String 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 return MemberType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from granteeTypeAsString().

Returns:

The type of user, group, or resource referred to in GranteeId.

See Also:

MemberType

permissionValues

public final List<PermissionType> 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 the isEmpty() 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

public final List<String> 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

public Permission.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Permission.Builder,Permission>

builder

public static Permission.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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