/* * 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; /** *
* Gets the membership preferences of an AppInstanceUser
or
* AppInstanceBot
for the specified channel. A user or a bot must
* be a member of the channel and own the membership in order to retrieve
* membership preferences. Users or bots in the AppInstanceAdmin
* and channel moderator roles can't retrieve preferences for other users or
* bots. Banned users or bots can't retrieve membership preferences for the
* channel from which they are banned.
*
* The x-amz-chime-bearer
request header is mandatory. Use the ARN
* of the AppInstanceUser
or AppInstanceBot
that makes
* the API call as the value in the header.
*
* The ARN of 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 channelArn;
/**
*
* The AppInstanceUserArn
of the member retrieving the
* preferences.
*
* 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 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 ARN of 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 ARN of the channel. *
*/ public String getChannelArn() { return channelArn; } /** ** The ARN of 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 channelArn
* The ARN of the channel. *
*/ public void setChannelArn(String channelArn) { this.channelArn = channelArn; } /** ** The ARN of 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 channelArn
* The ARN of the channel. *
* @return A reference to this updated object so that method calls can be * chained together. */ public GetChannelMembershipPreferencesRequest withChannelArn(String channelArn) { this.channelArn = channelArn; return this; } /** *
* The AppInstanceUserArn
of the member retrieving the
* preferences.
*
* 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 retrieving the
* preferences.
*
* The AppInstanceUserArn
of the member retrieving the
* preferences.
*
* 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 retrieving
* the preferences.
*
* The AppInstanceUserArn
of the member retrieving the
* preferences.
*
* 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 retrieving
* the preferences.
*
* 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.
*
* 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.
*
* 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.
*