com.amazonaws.services.chime.model

Class CreateChannelRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.chime.model.CreateChannelRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateChannelRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateChannelRequest()

Method Summary

Modifier and Type	Method and Description
CreateChannelRequest	clone()
boolean	equals(Object obj)
String	getAppInstanceArn() The ARN of the channel request.
String	getClientRequestToken() The client token for the request.
String	getMetadata() The metadata of the creation request.
String	getMode() The channel mode: UNRESTRICTED or RESTRICTED.
String	getName() The name of the channel.
String	getPrivacy() The channel's privacy level: PUBLIC or PRIVATE.
List<Tag>	getTags()
int	hashCode()
void	setAppInstanceArn(String appInstanceArn) The ARN of the channel request.
void	setClientRequestToken(String clientRequestToken) The client token for the request.
void	setMetadata(String metadata) The metadata of the creation request.
void	setMode(String mode) The channel mode: UNRESTRICTED or RESTRICTED.
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)
String	toString() Returns a string representation of this object.
CreateChannelRequest	withAppInstanceArn(String appInstanceArn) The ARN of the channel request.
CreateChannelRequest	withClientRequestToken(String clientRequestToken) The client token for 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	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)
CreateChannelRequest	withTags(Tag... tags) NOTE: This method appends the values to the existing list (if any).

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, 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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateChannelRequest

public CreateChannelRequest()

Method Detail

setAppInstanceArn

public void setAppInstanceArn(String appInstanceArn)

The ARN of the channel request.

Parameters:

appInstanceArn - The ARN of the channel request.

getAppInstanceArn

public String getAppInstanceArn()

The ARN of the channel request.

Returns:

The ARN of the channel request.

withAppInstanceArn

public CreateChannelRequest withAppInstanceArn(String appInstanceArn)

The ARN of the channel request.

Parameters:

appInstanceArn - The ARN of the channel request.

Returns:

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

setName

public void setName(String name)

The name of the channel.

Parameters:

name - The name of the channel.

getName

public String getName()

The name of the channel.

Returns:

The name of the channel.

withName

public CreateChannelRequest withName(String name)

The name of the channel.

Parameters:

name - The name of the channel.

Returns:

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

setMode

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.

Parameters:

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.

See Also:

ChannelMode

getMode

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.

Returns:

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.

See Also:

ChannelMode

withMode

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.

Parameters:

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.

Returns:

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

See Also:

ChannelMode

withMode

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.

Parameters:

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.

Returns:

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

See Also:

ChannelMode

setPrivacy

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 app instance.

Parameters:

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 app instance.

See Also:

ChannelPrivacy

getPrivacy

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 app instance.

Returns:

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 app instance.

See Also:

ChannelPrivacy

withPrivacy

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 app instance.

Parameters:

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 app instance.

Returns:

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

See Also:

ChannelPrivacy

withPrivacy

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 app instance.

Parameters:

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 app instance.

Returns:

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

See Also:

ChannelPrivacy

setMetadata

public void setMetadata(String metadata)

The metadata of the creation request. Limited to 1KB and UTF-8.

Parameters:

metadata - The metadata of the creation request. Limited to 1KB and UTF-8.

getMetadata

public String getMetadata()

The metadata of the creation request. Limited to 1KB and UTF-8.

Returns:

The metadata of the creation request. Limited to 1KB and UTF-8.

withMetadata

public CreateChannelRequest withMetadata(String metadata)

The metadata of the creation request. Limited to 1KB and UTF-8.

Parameters:

metadata - The metadata of the creation request. Limited to 1KB and UTF-8.

Returns:

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

setClientRequestToken

public void setClientRequestToken(String clientRequestToken)

The client token for the request. An Idempotency token.

Parameters:

clientRequestToken - The client token for the request. An Idempotency token.

getClientRequestToken

public String getClientRequestToken()

The client token for the request. An Idempotency token.

Returns:

The client token for the request. An Idempotency token.

withClientRequestToken

public CreateChannelRequest withClientRequestToken(String clientRequestToken)

The client token for the request. An Idempotency token.

Parameters:

clientRequestToken - The client token for the request. An Idempotency token.

Returns:

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

getTags

public List<Tag> getTags()

Returns:

setTags

public void setTags(Collection<Tag> tags)

Parameters:

tags -

withTags

public CreateChannelRequest withTags(Tag... tags)

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.

Parameters:

tags -

Returns:

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

withTags

public CreateChannelRequest withTags(Collection<Tag> tags)

Parameters:

tags -

Returns:

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

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateChannelRequest clone()

Overrides:

clone in class AmazonWebServiceRequest