com.amazonaws.services.workmail.model.Permission Maven / Gradle / Ivy
Show all versions of aws-java-sdk-workmail Show documentation
/*
* Copyright 2016-2021 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.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Permission granted to a user, group, or resource to access a certain aspect of another user, group, or resource
* mailbox.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Permission implements Serializable, Cloneable, StructuredPojo {
/**
*
* The identifier of the user, group, or resource to which the permissions are granted.
*
*/
private String granteeId;
/**
*
* The type of user, group, or resource referred to in GranteeId.
*
*/
private String granteeType;
/**
*
* 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 user, group, or resource to which the permissions are granted.
*
*
* @param granteeId
* The identifier of the user, group, or resource to which the permissions are granted.
*/
public void setGranteeId(String granteeId) {
this.granteeId = granteeId;
}
/**
*
* The identifier of the user, group, or resource to which the permissions are granted.
*
*
* @return The identifier of the user, group, or resource to which the permissions are granted.
*/
public String getGranteeId() {
return this.granteeId;
}
/**
*
* The identifier of the user, group, or resource to which the permissions are granted.
*
*
* @param granteeId
* The identifier of the user, group, or resource to which the permissions are granted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Permission withGranteeId(String granteeId) {
setGranteeId(granteeId);
return this;
}
/**
*
* The type of user, group, or resource referred to in GranteeId.
*
*
* @param granteeType
* The type of user, group, or resource referred to in GranteeId.
* @see MemberType
*/
public void setGranteeType(String granteeType) {
this.granteeType = granteeType;
}
/**
*
* The type of user, group, or resource referred to in GranteeId.
*
*
* @return The type of user, group, or resource referred to in GranteeId.
* @see MemberType
*/
public String getGranteeType() {
return this.granteeType;
}
/**
*
* The type of user, group, or resource referred to in GranteeId.
*
*
* @param granteeType
* The type of user, group, or resource referred to in GranteeId.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MemberType
*/
public Permission withGranteeType(String granteeType) {
setGranteeType(granteeType);
return this;
}
/**
*
* The type of user, group, or resource referred to in GranteeId.
*
*
* @param granteeType
* The type of user, group, or resource referred to in GranteeId.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MemberType
*/
public Permission withGranteeType(MemberType granteeType) {
this.granteeType = granteeType.toString();
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 Permission 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 Permission 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 Permission 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 (getGranteeId() != null)
sb.append("GranteeId: ").append(getGranteeId()).append(",");
if (getGranteeType() != null)
sb.append("GranteeType: ").append(getGranteeType()).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 Permission == false)
return false;
Permission other = (Permission) obj;
if (other.getGranteeId() == null ^ this.getGranteeId() == null)
return false;
if (other.getGranteeId() != null && other.getGranteeId().equals(this.getGranteeId()) == false)
return false;
if (other.getGranteeType() == null ^ this.getGranteeType() == null)
return false;
if (other.getGranteeType() != null && other.getGranteeType().equals(this.getGranteeType()) == 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 + ((getGranteeId() == null) ? 0 : getGranteeId().hashCode());
hashCode = prime * hashCode + ((getGranteeType() == null) ? 0 : getGranteeType().hashCode());
hashCode = prime * hashCode + ((getPermissionValues() == null) ? 0 : getPermissionValues().hashCode());
return hashCode;
}
@Override
public Permission clone() {
try {
return (Permission) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.workmail.model.transform.PermissionMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}