software.amazon.awssdk.services.workmail.model

Class PutMailboxPermissionsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.workmail.model.WorkMailRequest

software.amazon.awssdk.services.workmail.model.PutMailboxPermissionsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutMailboxPermissionsRequest.Builder,PutMailboxPermissionsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class PutMailboxPermissionsRequest
extends WorkMailRequest
implements ToCopyableBuilder<PutMailboxPermissionsRequest.Builder,PutMailboxPermissionsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PutMailboxPermissionsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static PutMailboxPermissionsRequest.Builder	builder()
String	entityId() The identifier of the user, group, or resource for which to update mailbox permissions.
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 to grant the permissions.
int	hashCode()
boolean	hasPermissionValues() Returns true if the PermissionValues property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	organizationId() The identifier of the organization under which the user, group, or resource exists.
List<PermissionType>	permissionValues() The permissions granted to the grantee.
List<String>	permissionValuesAsStrings() The permissions granted to the grantee.
List<SdkField<?>>	sdkFields()
static Class<? extends PutMailboxPermissionsRequest.Builder>	serializableBuilderClass()
PutMailboxPermissionsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

organizationId

public final String organizationId()

The identifier of the organization under which the user, group, or resource exists.

Returns:

The identifier of the organization under which the user, group, or resource exists.

entityId

public final String entityId()

The identifier of the user, group, or resource for which to update mailbox permissions.

Returns:

The identifier of the user, group, or resource for which to update mailbox permissions.

granteeId

public final String granteeId()

The identifier of the user, group, or resource to which to grant the permissions.

Returns:

The identifier of the user, group, or resource to which to grant the permissions.

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.

You can use hasPermissionValues() to see if a value was sent in this field.

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()

Returns true if the PermissionValues property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasPermissionValues() to see if a value was sent in this field.

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 PutMailboxPermissionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutMailboxPermissionsRequest.Builder,PutMailboxPermissionsRequest>

Specified by:

toBuilder in class WorkMailRequest

builder

public static PutMailboxPermissionsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutMailboxPermissionsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo