com.amazonaws.services.workmail.model.PutMailboxPermissionsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-workmail Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.workmail.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PutMailboxPermissionsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The identifier of the organization under which the user, group, or resource exists.
*
*/
private String organizationId;
/**
*
* 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: [email protected]
*
*
* -
*
* Entity name: entity
*
*
*
*/
private String entityId;
/**
*
* 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: [email protected]
*
*
* -
*
* Grantee name: grantee
*
*
*
*/
private String granteeId;
/**
*
* 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.
*
*/
private java.util.List permissionValues;
/**
*
* The identifier of the organization under which the user, group, or resource exists.
*
*
* @param organizationId
* The identifier of the organization under which the user, group, or resource exists.
*/
public void setOrganizationId(String organizationId) {
this.organizationId = organizationId;
}
/**
*
* The identifier of the organization under which the user, group, or resource exists.
*
*
* @return The identifier of the organization under which the user, group, or resource exists.
*/
public String getOrganizationId() {
return this.organizationId;
}
/**
*
* The identifier of the organization under which the user, group, or resource exists.
*
*
* @param organizationId
* The identifier of the organization under which the user, group, or resource exists.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutMailboxPermissionsRequest withOrganizationId(String organizationId) {
setOrganizationId(organizationId);
return this;
}
/**
*
* 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: [email protected]
*
*
* -
*
* Entity name: entity
*
*
*
*
* @param 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: [email protected]
*
*
* -
*
* Entity name: entity
*
*
*/
public void setEntityId(String entityId) {
this.entityId = 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: [email protected]
*
*
* -
*
* Entity name: entity
*
*
*
*
* @return 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: [email protected]
*
*
* -
*
* Entity name: entity
*
*
*/
public String getEntityId() {
return this.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: [email protected]
*
*
* -
*
* Entity name: entity
*
*
*
*
* @param 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: [email protected]
*
*
* -
*
* Entity name: entity
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutMailboxPermissionsRequest withEntityId(String entityId) {
setEntityId(entityId);
return this;
}
/**
*
* 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: [email protected]
*
*
* -
*
* Grantee name: grantee
*
*
*
*
* @param 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: [email protected]
*
*
* -
*
* Grantee name: grantee
*
*
*/
public void setGranteeId(String granteeId) {
this.granteeId = 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: [email protected]
*
*
* -
*
* Grantee name: grantee
*
*
*
*
* @return 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: [email protected]
*
*
* -
*
* Grantee name: grantee
*
*
*/
public String getGranteeId() {
return this.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: [email protected]
*
*
* -
*
* Grantee name: grantee
*
*
*
*
* @param 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: [email protected]
*
*
* -
*
* Grantee name: grantee
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutMailboxPermissionsRequest withGranteeId(String granteeId) {
setGranteeId(granteeId);
return this;
}
/**
*
* 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.
*
*
* @return 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.
* @see PermissionType
*/
public java.util.List getPermissionValues() {
return 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.
*
*
* @param 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.
* @see PermissionType
*/
public void setPermissionValues(java.util.Collection permissionValues) {
if (permissionValues == null) {
this.permissionValues = null;
return;
}
this.permissionValues = new java.util.ArrayList(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.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setPermissionValues(java.util.Collection)} or {@link #withPermissionValues(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PermissionType
*/
public PutMailboxPermissionsRequest withPermissionValues(String... permissionValues) {
if (this.permissionValues == null) {
setPermissionValues(new java.util.ArrayList(permissionValues.length));
}
for (String ele : permissionValues) {
this.permissionValues.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PermissionType
*/
public PutMailboxPermissionsRequest withPermissionValues(java.util.Collection permissionValues) {
setPermissionValues(permissionValues);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PermissionType
*/
public PutMailboxPermissionsRequest withPermissionValues(PermissionType... permissionValues) {
java.util.ArrayList permissionValuesCopy = new java.util.ArrayList(permissionValues.length);
for (PermissionType value : permissionValues) {
permissionValuesCopy.add(value.toString());
}
if (getPermissionValues() == null) {
setPermissionValues(permissionValuesCopy);
} else {
getPermissionValues().addAll(permissionValuesCopy);
}
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getOrganizationId() != null)
sb.append("OrganizationId: ").append(getOrganizationId()).append(",");
if (getEntityId() != null)
sb.append("EntityId: ").append(getEntityId()).append(",");
if (getGranteeId() != null)
sb.append("GranteeId: ").append(getGranteeId()).append(",");
if (getPermissionValues() != null)
sb.append("PermissionValues: ").append(getPermissionValues());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PutMailboxPermissionsRequest == false)
return false;
PutMailboxPermissionsRequest other = (PutMailboxPermissionsRequest) obj;
if (other.getOrganizationId() == null ^ this.getOrganizationId() == null)
return false;
if (other.getOrganizationId() != null && other.getOrganizationId().equals(this.getOrganizationId()) == false)
return false;
if (other.getEntityId() == null ^ this.getEntityId() == null)
return false;
if (other.getEntityId() != null && other.getEntityId().equals(this.getEntityId()) == false)
return false;
if (other.getGranteeId() == null ^ this.getGranteeId() == null)
return false;
if (other.getGranteeId() != null && other.getGranteeId().equals(this.getGranteeId()) == false)
return false;
if (other.getPermissionValues() == null ^ this.getPermissionValues() == null)
return false;
if (other.getPermissionValues() != null && other.getPermissionValues().equals(this.getPermissionValues()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getOrganizationId() == null) ? 0 : getOrganizationId().hashCode());
hashCode = prime * hashCode + ((getEntityId() == null) ? 0 : getEntityId().hashCode());
hashCode = prime * hashCode + ((getGranteeId() == null) ? 0 : getGranteeId().hashCode());
hashCode = prime * hashCode + ((getPermissionValues() == null) ? 0 : getPermissionValues().hashCode());
return hashCode;
}
@Override
public PutMailboxPermissionsRequest clone() {
return (PutMailboxPermissionsRequest) super.clone();
}
}