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("software.amazon.awssdk:codegen") public final class PutMailboxPermissionsRequest extends WorkMailRequest implements ToCopyableBuilder<PutMailboxPermissionsRequest.Builder,PutMailboxPermissionsRequest>

  • Method Details

    • 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 or resource for which to update mailbox permissions.

      The identifier can be UserId, ResourceID, or Group Id, Username, Resourcename, or Groupname, or email.

      • Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234

      • Email address: entity@domain.tld

      • Entity name: entity

      Returns:
      The identifier of the user or resource for which to update mailbox permissions.

      The identifier can be UserId, ResourceID, or Group Id, Username, Resourcename, or Groupname, or email.

      • Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234

      • Email address: entity@domain.tld

      • Entity name: entity

    • granteeId

      public final String granteeId()

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

      The identifier can be UserId, ResourceID, or Group Id, Username, Resourcename, or Groupname, or email.

      • Grantee ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234

      • Email address: grantee@domain.tld

      • Grantee name: grantee

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

      The identifier can be UserId, ResourceID, or Group Id, Username, Resourcename, or Groupname, or email.

      • Grantee ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234

      • Email address: grantee@domain.tld

      • Grantee name: grantee

    • 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 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 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)
      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)
      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 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.