/* * 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; /** *
* Update a channel's attributes. *
** Restriction: You can't change a channel's privacy. *
*
* 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 name of the channel. *
*
* Constraints:
* Length: 1 - 256
* Pattern: [
* -\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
*/
private String name;
/**
*
* The mode of the update request. *
*
* Constraints:
* Allowed Values: UNRESTRICTED, RESTRICTED
*/
private String mode;
/**
*
* The metadata for the update request. *
*
* Constraints:
* Length: 0 - 1024
* Pattern: .*
*/
private String metadata;
/**
*
* 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 UpdateChannelRequest withChannelArn(String channelArn) { this.channelArn = channelArn; return this; } /** ** The name of the channel. *
*
* Constraints:
* Length: 1 - 256
* Pattern: [
* -\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
*
* @return
* The name of the channel. *
*/ public String getName() { return name; } /** ** The name of the channel. *
*
* Constraints:
* Length: 1 - 256
* Pattern: [
* -\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
*
* @param name
* The name of the channel. *
*/ public void setName(String name) { this.name = name; } /** ** The name of the channel. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 1 - 256
* Pattern: [
* -\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*
*
* @param name
* The name of the channel. *
* @return A reference to this updated object so that method calls can be * chained together. */ public UpdateChannelRequest withName(String name) { this.name = name; return this; } /** ** The mode of the update request. *
*
* Constraints:
* Allowed Values: UNRESTRICTED, RESTRICTED
*
* @return
* The mode of the update request. *
* @see ChannelMode */ public String getMode() { return mode; } /** ** The mode of the update request. *
*
* Constraints:
* Allowed Values: UNRESTRICTED, RESTRICTED
*
* @param mode
* The mode of the update request. *
* @see ChannelMode */ public void setMode(String mode) { this.mode = mode; } /** ** The mode of the update request. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: UNRESTRICTED, RESTRICTED
*
* @param mode
* The mode of the update request. *
* @return A reference to this updated object so that method calls can be * chained together. * @see ChannelMode */ public UpdateChannelRequest withMode(String mode) { this.mode = mode; return this; } /** ** The mode of the update request. *
*
* Constraints:
* Allowed Values: UNRESTRICTED, RESTRICTED
*
* @param mode
* The mode of the update request. *
* @see ChannelMode */ public void setMode(ChannelMode mode) { this.mode = mode.toString(); } /** ** The mode of the update request. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: UNRESTRICTED, RESTRICTED
*
* @param mode
* The mode of the update request. *
* @return A reference to this updated object so that method calls can be * chained together. * @see ChannelMode */ public UpdateChannelRequest withMode(ChannelMode mode) { this.mode = mode.toString(); return this; } /** ** The metadata for the update request. *
*
* Constraints:
* Length: 0 - 1024
* Pattern: .*
*
* @return
* The metadata for the update request. *
*/ public String getMetadata() { return metadata; } /** ** The metadata for the update request. *
*
* Constraints:
* Length: 0 - 1024
* Pattern: .*
*
* @param metadata
* The metadata for the update request. *
*/ public void setMetadata(String metadata) { this.metadata = metadata; } /** ** The metadata for the update request. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 0 - 1024
* Pattern: .*
*
* @param metadata
* The metadata for the update request. *
* @return A reference to this updated object so that method calls can be * chained together. */ public UpdateChannelRequest withMetadata(String metadata) { this.metadata = metadata; 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.
*
* 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.
*