/* * Copyright 2010-2023 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.chimesdkmessaging.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* Adds a member to a channel. The InvitedBy field in * ChannelMembership is derived from the request header. A channel * member can: *

*
* List messages *
*
*
* Send messages *
*
*
* Receive messages *
*
*
* Edit their own messages *
*
*
* Leave the channel *
*

* Privacy settings impact this action as follows: *

*
* Public Channels: You do not need to be a member to list messages, but you * must be a member to send messages. *
*
*
* Private Channels: You must be a member to list or send messages. *
*

* *

* The x-amz-chime-bearer request header is mandatory. Use the ARN * of the AppInstanceUserArn or AppInstanceBot that * makes the API call as the value in the header. *

* */ public class CreateChannelMembershipRequest extends AmazonWebServiceRequest implements Serializable { /** *

* The ARN of the channel to which you're adding users. *

* Constraints:
* Length: 5 - 1600
* Pattern: * arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}: * [a-z0-9-\.]{0,63}:[^/].{0,1023}
*/ private String channelArn; /** *

* The AppInstanceUserArn of the member you want to add to the * channel. *

* Constraints:
* Length: 5 - 1600
* Pattern: * arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}: * [a-z0-9-\.]{0,63}:[^/].{0,1023}
*/ private String memberArn; /** *

* The membership type of a user, DEFAULT or * HIDDEN. Default members are always returned as part of * ListChannelMemberships. Hidden members are only returned if * the type filter in ListChannelMemberships equals * HIDDEN. Otherwise hidden members are not returned. This is * only supported by moderators. *

* Constraints:
* Allowed Values: DEFAULT, HIDDEN */ private String type; /** *

* The ARN of the AppInstanceUser or * AppInstanceBot that makes the API call. *

* Constraints:
* Length: 5 - 1600
* Pattern: * arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}: * [a-z0-9-\.]{0,63}:[^/].{0,1023}
*/ private String chimeBearer; /** *

* The ID of the SubChannel in the request. *

* *

* Only required when creating membership in a SubChannel for a moderator in * an elastic channel. *

* *

* Constraints:
* Length: 1 - 128
* Pattern: [-_a-zA-Z0-9]*
*/ private String subChannelId; /** *

* The ARN of the channel to which you're adding users. *

* Constraints:
* Length: 5 - 1600
* Pattern: * arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}: * [a-z0-9-\.]{0,63}:[^/].{0,1023}
* * @return

* The ARN of the channel to which you're adding users. *

*/ public String getChannelArn() { return channelArn; } /** *

* The ARN of the channel to which you're adding users. *

* Constraints:
* Length: 5 - 1600
* Pattern: * arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}: * [a-z0-9-\.]{0,63}:[^/].{0,1023}
* * @param channelArn

* The ARN of the channel to which you're adding users. *

*/ public void setChannelArn(String channelArn) { this.channelArn = channelArn; } /** *

* The ARN of the channel to which you're adding users. *

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 5 - 1600
* Pattern: * arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}: * [a-z0-9-\.]{0,63}:[^/].{0,1023}
* * @param channelArn

* The ARN of the channel to which you're adding users. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CreateChannelMembershipRequest withChannelArn(String channelArn) { this.channelArn = channelArn; return this; } /** *

* The AppInstanceUserArn of the member you want to add to the * channel. *

* Constraints:
* Length: 5 - 1600
* Pattern: * arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}: * [a-z0-9-\.]{0,63}:[^/].{0,1023}
* * @return

* The AppInstanceUserArn of the member you want to add * to the channel. *

*/ public String getMemberArn() { return memberArn; } /** *

* The AppInstanceUserArn of the member you want to add to the * channel. *

* Constraints:
* Length: 5 - 1600
* Pattern: * arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}: * [a-z0-9-\.]{0,63}:[^/].{0,1023}
* * @param memberArn

* The AppInstanceUserArn of the member you want to * add to the channel. *

*/ public void setMemberArn(String memberArn) { this.memberArn = memberArn; } /** *

* The AppInstanceUserArn of the member you want to add to the * channel. *

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 5 - 1600
* Pattern: * arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}: * [a-z0-9-\.]{0,63}:[^/].{0,1023}
* * @param memberArn

* The AppInstanceUserArn of the member you want to * add to the channel. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CreateChannelMembershipRequest withMemberArn(String memberArn) { this.memberArn = memberArn; return this; } /** *

* Constraints:
* Allowed Values: DEFAULT, HIDDEN * * @return

* The membership type of a user, DEFAULT or * HIDDEN. Default members are always returned as part * of ListChannelMemberships. Hidden members are only * returned if the type filter in * ListChannelMemberships equals HIDDEN. * Otherwise hidden members are not returned. This is only supported * by moderators. *

* @see ChannelMembershipType */ public String getType() { return type; } /** *

* Constraints:
* Allowed Values: DEFAULT, HIDDEN * * @param type

* The membership type of a user, DEFAULT or * HIDDEN. Default members are always returned as * part of ListChannelMemberships. Hidden members * are only returned if the type filter in * ListChannelMemberships equals HIDDEN * . Otherwise hidden members are not returned. This is only * supported by moderators. *

* @see ChannelMembershipType */ public void setType(String type) { this.type = type; } /** *

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Allowed Values: DEFAULT, HIDDEN * * @param type

* @return A reference to this updated object so that method calls can be * chained together. * @see ChannelMembershipType */ public CreateChannelMembershipRequest withType(String type) { this.type = type; return this; } /** *

* Constraints:
* Allowed Values: DEFAULT, HIDDEN * * @param type

* @see ChannelMembershipType */ public void setType(ChannelMembershipType type) { this.type = type.toString(); } /** *

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Allowed Values: DEFAULT, HIDDEN * * @param type

* @return A reference to this updated object so that method calls can be * chained together. * @see ChannelMembershipType */ public CreateChannelMembershipRequest withType(ChannelMembershipType type) { this.type = type.toString(); return this; } /** *

* The ARN of the AppInstanceUser or * AppInstanceBot that makes the API call. *

* Constraints:
* Length: 5 - 1600
* Pattern: * arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}: * [a-z0-9-\.]{0,63}:[^/].{0,1023}
* * @return

* The ARN of the AppInstanceUser or * AppInstanceBot that makes the API call. *

*/ public String getChimeBearer() { return chimeBearer; } /** *

* The ARN of the AppInstanceUser or * AppInstanceBot that makes the API call. *

* Constraints:
* Length: 5 - 1600
* Pattern: * arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}: * [a-z0-9-\.]{0,63}:[^/].{0,1023}
* * @param chimeBearer

* The ARN of the AppInstanceUser or * AppInstanceBot that makes the API call. *

*/ public void setChimeBearer(String chimeBearer) { this.chimeBearer = chimeBearer; } /** *

* The ARN of the AppInstanceUser or * AppInstanceBot that makes the API call. *

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 5 - 1600
* Pattern: * arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}: * [a-z0-9-\.]{0,63}:[^/].{0,1023}
* * @param chimeBearer

* The ARN of the AppInstanceUser or * AppInstanceBot that makes the API call. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CreateChannelMembershipRequest withChimeBearer(String chimeBearer) { this.chimeBearer = chimeBearer; return this; } /** *

* The ID of the SubChannel in the request. *

* *

* Only required when creating membership in a SubChannel for a moderator in * an elastic channel. *

* *

* Constraints:
* Length: 1 - 128
* Pattern: [-_a-zA-Z0-9]*
* * @return

* The ID of the SubChannel in the request. *

* *

* Only required when creating membership in a SubChannel for a * moderator in an elastic channel. *

* */ public String getSubChannelId() { return subChannelId; } /** *

* The ID of the SubChannel in the request. *

* *

* Only required when creating membership in a SubChannel for a moderator in * an elastic channel. *

* *

* Constraints:
* Length: 1 - 128
* Pattern: [-_a-zA-Z0-9]*
* * @param subChannelId

* The ID of the SubChannel in the request. *

* *

* Only required when creating membership in a SubChannel for a * moderator in an elastic channel. *

* */ public void setSubChannelId(String subChannelId) { this.subChannelId = subChannelId; } /** *

* The ID of the SubChannel in the request. *

* *

* Only required when creating membership in a SubChannel for a moderator in * an elastic channel. *

* *

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 128
* Pattern: [-_a-zA-Z0-9]*
* * @param subChannelId

* The ID of the SubChannel in the request. *

* *

* Only required when creating membership in a SubChannel for a * moderator in an elastic channel. *

* * @return A reference to this updated object so that method calls can be * chained together. */ public CreateChannelMembershipRequest withSubChannelId(String subChannelId) { this.subChannelId = subChannelId; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getChannelArn() != null) sb.append("ChannelArn: " + getChannelArn() + ","); if (getMemberArn() != null) sb.append("MemberArn: " + getMemberArn() + ","); if (getType() != null) sb.append("Type: " + getType() + ","); if (getChimeBearer() != null) sb.append("ChimeBearer: " + getChimeBearer() + ","); if (getSubChannelId() != null) sb.append("SubChannelId: " + getSubChannelId()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getChannelArn() == null) ? 0 : getChannelArn().hashCode()); hashCode = prime * hashCode + ((getMemberArn() == null) ? 0 : getMemberArn().hashCode()); hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode()); hashCode = prime * hashCode + ((getChimeBearer() == null) ? 0 : getChimeBearer().hashCode()); hashCode = prime * hashCode + ((getSubChannelId() == null) ? 0 : getSubChannelId().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CreateChannelMembershipRequest == false) return false; CreateChannelMembershipRequest other = (CreateChannelMembershipRequest) obj; if (other.getChannelArn() == null ^ this.getChannelArn() == null) return false; if (other.getChannelArn() != null && other.getChannelArn().equals(this.getChannelArn()) == false) return false; if (other.getMemberArn() == null ^ this.getMemberArn() == null) return false; if (other.getMemberArn() != null && other.getMemberArn().equals(this.getMemberArn()) == false) return false; if (other.getType() == null ^ this.getType() == null) return false; if (other.getType() != null && other.getType().equals(this.getType()) == false) return false; if (other.getChimeBearer() == null ^ this.getChimeBearer() == null) return false; if (other.getChimeBearer() != null && other.getChimeBearer().equals(this.getChimeBearer()) == false) return false; if (other.getSubChannelId() == null ^ this.getSubChannelId() == null) return false; if (other.getSubChannelId() != null && other.getSubChannelId().equals(this.getSubChannelId()) == false) return false; return true; } }