@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateChannelRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateChannelRequest() |
Modifier and Type | Method and Description |
---|---|
CreateChannelRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getAppInstanceArn()
The ARN of the channel request.
|
String |
getChannelId()
The ID of the channel in the request.
|
String |
getChimeBearer()
The ARN of the
AppInstanceUser or AppInstanceBot that makes the API call. |
String |
getClientRequestToken()
The client token for the request.
|
ElasticChannelConfiguration |
getElasticChannelConfiguration()
The attributes required to configure and create an elastic channel.
|
ExpirationSettings |
getExpirationSettings()
Settings that control the interval after which the channel is automatically deleted.
|
List<String> |
getMemberArns()
The ARNs of the channel members in the request.
|
String |
getMetadata()
The metadata of the creation request.
|
String |
getMode()
The channel mode:
UNRESTRICTED or RESTRICTED . |
List<String> |
getModeratorArns()
The ARNs of the channel moderators in the request.
|
String |
getName()
The name of the channel.
|
String |
getPrivacy()
The channel's privacy level:
PUBLIC or PRIVATE . |
List<Tag> |
getTags()
The tags for the creation request.
|
int |
hashCode() |
void |
setAppInstanceArn(String appInstanceArn)
The ARN of the channel request.
|
void |
setChannelId(String channelId)
The ID of the channel in the request.
|
void |
setChimeBearer(String chimeBearer)
The ARN of the
AppInstanceUser or AppInstanceBot that makes the API call. |
void |
setClientRequestToken(String clientRequestToken)
The client token for the request.
|
void |
setElasticChannelConfiguration(ElasticChannelConfiguration elasticChannelConfiguration)
The attributes required to configure and create an elastic channel.
|
void |
setExpirationSettings(ExpirationSettings expirationSettings)
Settings that control the interval after which the channel is automatically deleted.
|
void |
setMemberArns(Collection<String> memberArns)
The ARNs of the channel members in the request.
|
void |
setMetadata(String metadata)
The metadata of the creation request.
|
void |
setMode(String mode)
The channel mode:
UNRESTRICTED or RESTRICTED . |
void |
setModeratorArns(Collection<String> moderatorArns)
The ARNs of the channel moderators in the request.
|
void |
setName(String name)
The name of the channel.
|
void |
setPrivacy(String privacy)
The channel's privacy level:
PUBLIC or PRIVATE . |
void |
setTags(Collection<Tag> tags)
The tags for the creation request.
|
String |
toString()
Returns a string representation of this object.
|
CreateChannelRequest |
withAppInstanceArn(String appInstanceArn)
The ARN of the channel request.
|
CreateChannelRequest |
withChannelId(String channelId)
The ID of the channel in the request.
|
CreateChannelRequest |
withChimeBearer(String chimeBearer)
The ARN of the
AppInstanceUser or AppInstanceBot that makes the API call. |
CreateChannelRequest |
withClientRequestToken(String clientRequestToken)
The client token for the request.
|
CreateChannelRequest |
withElasticChannelConfiguration(ElasticChannelConfiguration elasticChannelConfiguration)
The attributes required to configure and create an elastic channel.
|
CreateChannelRequest |
withExpirationSettings(ExpirationSettings expirationSettings)
Settings that control the interval after which the channel is automatically deleted.
|
CreateChannelRequest |
withMemberArns(Collection<String> memberArns)
The ARNs of the channel members in the request.
|
CreateChannelRequest |
withMemberArns(String... memberArns)
The ARNs of the channel members in the request.
|
CreateChannelRequest |
withMetadata(String metadata)
The metadata of the creation request.
|
CreateChannelRequest |
withMode(ChannelMode mode)
The channel mode:
UNRESTRICTED or RESTRICTED . |
CreateChannelRequest |
withMode(String mode)
The channel mode:
UNRESTRICTED or RESTRICTED . |
CreateChannelRequest |
withModeratorArns(Collection<String> moderatorArns)
The ARNs of the channel moderators in the request.
|
CreateChannelRequest |
withModeratorArns(String... moderatorArns)
The ARNs of the channel moderators in the request.
|
CreateChannelRequest |
withName(String name)
The name of the channel.
|
CreateChannelRequest |
withPrivacy(ChannelPrivacy privacy)
The channel's privacy level:
PUBLIC or PRIVATE . |
CreateChannelRequest |
withPrivacy(String privacy)
The channel's privacy level:
PUBLIC or PRIVATE . |
CreateChannelRequest |
withTags(Collection<Tag> tags)
The tags for the creation request.
|
CreateChannelRequest |
withTags(Tag... tags)
The tags for the creation request.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setAppInstanceArn(String appInstanceArn)
The ARN of the channel request.
appInstanceArn
- The ARN of the channel request.public String getAppInstanceArn()
The ARN of the channel request.
public CreateChannelRequest withAppInstanceArn(String appInstanceArn)
The ARN of the channel request.
appInstanceArn
- The ARN of the channel request.public void setName(String name)
The name of the channel.
name
- The name of the channel.public String getName()
The name of the channel.
public CreateChannelRequest withName(String name)
The name of the channel.
name
- The name of the channel.public void setMode(String mode)
The channel mode: UNRESTRICTED
or RESTRICTED
. Administrators, moderators, and channel
members can add themselves and other members to unrestricted channels. Only administrators and moderators can add
members to restricted channels.
mode
- The channel mode: UNRESTRICTED
or RESTRICTED
. Administrators, moderators, and
channel members can add themselves and other members to unrestricted channels. Only administrators and
moderators can add members to restricted channels.ChannelMode
public String getMode()
The channel mode: UNRESTRICTED
or RESTRICTED
. Administrators, moderators, and channel
members can add themselves and other members to unrestricted channels. Only administrators and moderators can add
members to restricted channels.
UNRESTRICTED
or RESTRICTED
. Administrators, moderators, and
channel members can add themselves and other members to unrestricted channels. Only administrators and
moderators can add members to restricted channels.ChannelMode
public CreateChannelRequest withMode(String mode)
The channel mode: UNRESTRICTED
or RESTRICTED
. Administrators, moderators, and channel
members can add themselves and other members to unrestricted channels. Only administrators and moderators can add
members to restricted channels.
mode
- The channel mode: UNRESTRICTED
or RESTRICTED
. Administrators, moderators, and
channel members can add themselves and other members to unrestricted channels. Only administrators and
moderators can add members to restricted channels.ChannelMode
public CreateChannelRequest withMode(ChannelMode mode)
The channel mode: UNRESTRICTED
or RESTRICTED
. Administrators, moderators, and channel
members can add themselves and other members to unrestricted channels. Only administrators and moderators can add
members to restricted channels.
mode
- The channel mode: UNRESTRICTED
or RESTRICTED
. Administrators, moderators, and
channel members can add themselves and other members to unrestricted channels. Only administrators and
moderators can add members to restricted channels.ChannelMode
public void setPrivacy(String privacy)
The channel's privacy level: PUBLIC
or PRIVATE
. Private channels aren't discoverable by
users outside the channel. Public channels are discoverable by anyone in the AppInstance
.
privacy
- The channel's privacy level: PUBLIC
or PRIVATE
. Private channels aren't
discoverable by users outside the channel. Public channels are discoverable by anyone in the
AppInstance
.ChannelPrivacy
public String getPrivacy()
The channel's privacy level: PUBLIC
or PRIVATE
. Private channels aren't discoverable by
users outside the channel. Public channels are discoverable by anyone in the AppInstance
.
PUBLIC
or PRIVATE
. Private channels aren't
discoverable by users outside the channel. Public channels are discoverable by anyone in the
AppInstance
.ChannelPrivacy
public CreateChannelRequest withPrivacy(String privacy)
The channel's privacy level: PUBLIC
or PRIVATE
. Private channels aren't discoverable by
users outside the channel. Public channels are discoverable by anyone in the AppInstance
.
privacy
- The channel's privacy level: PUBLIC
or PRIVATE
. Private channels aren't
discoverable by users outside the channel. Public channels are discoverable by anyone in the
AppInstance
.ChannelPrivacy
public CreateChannelRequest withPrivacy(ChannelPrivacy privacy)
The channel's privacy level: PUBLIC
or PRIVATE
. Private channels aren't discoverable by
users outside the channel. Public channels are discoverable by anyone in the AppInstance
.
privacy
- The channel's privacy level: PUBLIC
or PRIVATE
. Private channels aren't
discoverable by users outside the channel. Public channels are discoverable by anyone in the
AppInstance
.ChannelPrivacy
public void setMetadata(String metadata)
The metadata of the creation request. Limited to 1KB and UTF-8.
metadata
- The metadata of the creation request. Limited to 1KB and UTF-8.public String getMetadata()
The metadata of the creation request. Limited to 1KB and UTF-8.
public CreateChannelRequest withMetadata(String metadata)
The metadata of the creation request. Limited to 1KB and UTF-8.
metadata
- The metadata of the creation request. Limited to 1KB and UTF-8.public void setClientRequestToken(String clientRequestToken)
The client token for the request. An Idempotency
token.
clientRequestToken
- The client token for the request. An Idempotency
token.public String getClientRequestToken()
The client token for the request. An Idempotency
token.
Idempotency
token.public CreateChannelRequest withClientRequestToken(String clientRequestToken)
The client token for the request. An Idempotency
token.
clientRequestToken
- The client token for the request. An Idempotency
token.public List<Tag> getTags()
The tags for the creation request.
public void setTags(Collection<Tag> tags)
The tags for the creation request.
tags
- The tags for the creation request.public CreateChannelRequest withTags(Tag... tags)
The tags for the creation request.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- The tags for the creation request.public CreateChannelRequest withTags(Collection<Tag> tags)
The tags for the creation request.
tags
- The tags for the creation request.public void setChimeBearer(String chimeBearer)
The ARN of the AppInstanceUser
or AppInstanceBot
that makes the API call.
chimeBearer
- The ARN of the AppInstanceUser
or AppInstanceBot
that makes the API call.public String getChimeBearer()
The ARN of the AppInstanceUser
or AppInstanceBot
that makes the API call.
AppInstanceUser
or AppInstanceBot
that makes the API call.public CreateChannelRequest withChimeBearer(String chimeBearer)
The ARN of the AppInstanceUser
or AppInstanceBot
that makes the API call.
chimeBearer
- The ARN of the AppInstanceUser
or AppInstanceBot
that makes the API call.public void setChannelId(String channelId)
The ID of the channel in the request.
channelId
- The ID of the channel in the request.public String getChannelId()
The ID of the channel in the request.
public CreateChannelRequest withChannelId(String channelId)
The ID of the channel in the request.
channelId
- The ID of the channel in the request.public List<String> getMemberArns()
The ARNs of the channel members in the request.
public void setMemberArns(Collection<String> memberArns)
The ARNs of the channel members in the request.
memberArns
- The ARNs of the channel members in the request.public CreateChannelRequest withMemberArns(String... memberArns)
The ARNs of the channel members in the request.
NOTE: This method appends the values to the existing list (if any). Use
setMemberArns(java.util.Collection)
or withMemberArns(java.util.Collection)
if you want to
override the existing values.
memberArns
- The ARNs of the channel members in the request.public CreateChannelRequest withMemberArns(Collection<String> memberArns)
The ARNs of the channel members in the request.
memberArns
- The ARNs of the channel members in the request.public List<String> getModeratorArns()
The ARNs of the channel moderators in the request.
public void setModeratorArns(Collection<String> moderatorArns)
The ARNs of the channel moderators in the request.
moderatorArns
- The ARNs of the channel moderators in the request.public CreateChannelRequest withModeratorArns(String... moderatorArns)
The ARNs of the channel moderators in the request.
NOTE: This method appends the values to the existing list (if any). Use
setModeratorArns(java.util.Collection)
or withModeratorArns(java.util.Collection)
if you want
to override the existing values.
moderatorArns
- The ARNs of the channel moderators in the request.public CreateChannelRequest withModeratorArns(Collection<String> moderatorArns)
The ARNs of the channel moderators in the request.
moderatorArns
- The ARNs of the channel moderators in the request.public void setElasticChannelConfiguration(ElasticChannelConfiguration elasticChannelConfiguration)
The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.
elasticChannelConfiguration
- The attributes required to configure and create an elastic channel. An elastic channel can support a
maximum of 1-million users, excluding moderators.public ElasticChannelConfiguration getElasticChannelConfiguration()
The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.
public CreateChannelRequest withElasticChannelConfiguration(ElasticChannelConfiguration elasticChannelConfiguration)
The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.
elasticChannelConfiguration
- The attributes required to configure and create an elastic channel. An elastic channel can support a
maximum of 1-million users, excluding moderators.public void setExpirationSettings(ExpirationSettings expirationSettings)
Settings that control the interval after which the channel is automatically deleted.
expirationSettings
- Settings that control the interval after which the channel is automatically deleted.public ExpirationSettings getExpirationSettings()
Settings that control the interval after which the channel is automatically deleted.
public CreateChannelRequest withExpirationSettings(ExpirationSettings expirationSettings)
Settings that control the interval after which the channel is automatically deleted.
expirationSettings
- Settings that control the interval after which the channel is automatically deleted.public String toString()
toString
in class Object
Object.toString()
public CreateChannelRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()