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 entity (user or group) for which to update mailbox permissions.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
String	granteeId() The identifier of the entity (user or group) to which to grant the permissions.
int	hashCode()
String	organizationId() The identifier of the organization under which the entity (user or group) 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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

organizationId

public String organizationId()

The identifier of the organization under which the entity (user or group) exists.

Returns:

The identifier of the organization under which the entity (user or group) exists.

entityId

public String entityId()

The identifier of the entity (user or group) for which to update mailbox permissions.

Returns:

The identifier of the entity (user or group) for which to update mailbox permissions.

granteeId

public String granteeId()

The identifier of the entity (user or group) to which to grant the permissions.

Returns:

The identifier of the entity (user or group) to which to grant the permissions.

permissionValues

public 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.

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.

permissionValuesAsStrings

public 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.

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

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<PutMailboxPermissionsRequest.Builder,PutMailboxPermissionsRequest>

Specified by:

toBuilder in class WorkMailRequest

Returns:

a builder for type T

builder

public static PutMailboxPermissionsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public 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.