com.amazonaws.services.chimesdkmessaging.model

Class CreateChannelMembershipRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.chimesdkmessaging.model.CreateChannelMembershipRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateChannelMembershipRequest
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
CreateChannelMembershipRequest()

Method Summary

Modifier and Type	Method and Description
CreateChannelMembershipRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getChannelArn() The ARN of the channel to which you're adding users.
String	getChimeBearer() The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
String	getMemberArn() The AppInstanceUserArn of the member you want to add to the channel.
String	getSubChannelId() The ID of the SubChannel in the request.
String	getType() The membership type of a user, DEFAULT or HIDDEN.
int	hashCode()
void	setChannelArn(String channelArn) The ARN of the channel to which you're adding users.
void	setChimeBearer(String chimeBearer) The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
void	setMemberArn(String memberArn) The AppInstanceUserArn of the member you want to add to the channel.
void	setSubChannelId(String subChannelId) The ID of the SubChannel in the request.
void	setType(String type) The membership type of a user, DEFAULT or HIDDEN.
String	toString() Returns a string representation of this object.
CreateChannelMembershipRequest	withChannelArn(String channelArn) The ARN of the channel to which you're adding users.
CreateChannelMembershipRequest	withChimeBearer(String chimeBearer) The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
CreateChannelMembershipRequest	withMemberArn(String memberArn) The AppInstanceUserArn of the member you want to add to the channel.
CreateChannelMembershipRequest	withSubChannelId(String subChannelId) The ID of the SubChannel in the request.
CreateChannelMembershipRequest	withType(ChannelMembershipType type) The membership type of a user, DEFAULT or HIDDEN.
CreateChannelMembershipRequest	withType(String type) The membership type of a user, DEFAULT or HIDDEN.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateChannelMembershipRequest

public CreateChannelMembershipRequest()

Method Detail

setChannelArn

public void setChannelArn(String channelArn)

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

Parameters:

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

getChannelArn

public String getChannelArn()

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

Returns:

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

withChannelArn

public CreateChannelMembershipRequest withChannelArn(String channelArn)

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

Parameters:

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

Returns:

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

setMemberArn

public void setMemberArn(String memberArn)

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

Parameters:

memberArn - The AppInstanceUserArn of the member you want to add to the channel.

getMemberArn

public String getMemberArn()

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

Returns:

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

withMemberArn

public CreateChannelMembershipRequest withMemberArn(String memberArn)

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

Parameters:

memberArn - The AppInstanceUserArn of the member you want to add to the channel.

Returns:

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

setType

public void setType(String 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.

Parameters:

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 Also:

ChannelMembershipType

getType

public String getType()

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.

Returns:

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 Also:

ChannelMembershipType

withType

public CreateChannelMembershipRequest withType(String 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.

Parameters:

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.

Returns:

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

See Also:

ChannelMembershipType

withType

public CreateChannelMembershipRequest withType(ChannelMembershipType 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.

Parameters:

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.

Returns:

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

See Also:

ChannelMembershipType

setChimeBearer

public void setChimeBearer(String chimeBearer)

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

Parameters:

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

getChimeBearer

public String getChimeBearer()

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

Returns:

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

withChimeBearer

public CreateChannelMembershipRequest withChimeBearer(String chimeBearer)

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

Parameters:

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

Returns:

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

setSubChannelId

public void setSubChannelId(String subChannelId)

The ID of the SubChannel in the request.

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

Parameters:

subChannelId - The ID of the SubChannel in the request.

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

getSubChannelId

public String getSubChannelId()

The ID of the SubChannel in the request.

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

Returns:

The ID of the SubChannel in the request.

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

withSubChannelId

public CreateChannelMembershipRequest withSubChannelId(String subChannelId)

The ID of the SubChannel in the request.

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

Parameters:

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:

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 CreateChannelMembershipRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()