Channel (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.chimesdkmessaging.model.Channel

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

The details of a channel.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Channel()

Constructors
Constructor and Description
`Channel()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Channel`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getChannelArn()` The ARN of a channel.
`String`	`getChannelFlowArn()` The ARN of the channel flow.
`Identity`	`getCreatedBy()` The `AppInstanceUser` who created the channel.
`Date`	`getCreatedTimestamp()` The time at which the `AppInstanceUser` created the channel.
`ElasticChannelConfiguration`	`getElasticChannelConfiguration()` The attributes required to configure and create an elastic channel.
`ExpirationSettings`	`getExpirationSettings()` Settings that control when a channel expires.
`Date`	`getLastMessageTimestamp()` The time at which a member sent the last message in the channel.
`Date`	`getLastUpdatedTimestamp()` The time at which a channel was last updated.
`String`	`getMetadata()` The channel's metadata.
`String`	`getMode()` The mode of the channel.
`String`	`getName()` The name of a channel.
`String`	`getPrivacy()` The channel's privacy setting.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setChannelArn(String channelArn)` The ARN of a channel.
`void`	`setChannelFlowArn(String channelFlowArn)` The ARN of the channel flow.
`void`	`setCreatedBy(Identity createdBy)` The `AppInstanceUser` who created the channel.
`void`	`setCreatedTimestamp(Date createdTimestamp)` The time at which the `AppInstanceUser` created the channel.
`void`	`setElasticChannelConfiguration(ElasticChannelConfiguration elasticChannelConfiguration)` The attributes required to configure and create an elastic channel.
`void`	`setExpirationSettings(ExpirationSettings expirationSettings)` Settings that control when a channel expires.
`void`	`setLastMessageTimestamp(Date lastMessageTimestamp)` The time at which a member sent the last message in the channel.
`void`	`setLastUpdatedTimestamp(Date lastUpdatedTimestamp)` The time at which a channel was last updated.
`void`	`setMetadata(String metadata)` The channel's metadata.
`void`	`setMode(String mode)` The mode of the channel.
`void`	`setName(String name)` The name of a channel.
`void`	`setPrivacy(String privacy)` The channel's privacy setting.
`String`	`toString()` Returns a string representation of this object.
`Channel`	`withChannelArn(String channelArn)` The ARN of a channel.
`Channel`	`withChannelFlowArn(String channelFlowArn)` The ARN of the channel flow.
`Channel`	`withCreatedBy(Identity createdBy)` The `AppInstanceUser` who created the channel.
`Channel`	`withCreatedTimestamp(Date createdTimestamp)` The time at which the `AppInstanceUser` created the channel.
`Channel`	`withElasticChannelConfiguration(ElasticChannelConfiguration elasticChannelConfiguration)` The attributes required to configure and create an elastic channel.
`Channel`	`withExpirationSettings(ExpirationSettings expirationSettings)` Settings that control when a channel expires.
`Channel`	`withLastMessageTimestamp(Date lastMessageTimestamp)` The time at which a member sent the last message in the channel.
`Channel`	`withLastUpdatedTimestamp(Date lastUpdatedTimestamp)` The time at which a channel was last updated.
`Channel`	`withMetadata(String metadata)` The channel's metadata.
`Channel`	`withMode(ChannelMode mode)` The mode of the channel.
`Channel`	`withMode(String mode)` The mode of the channel.
`Channel`	`withName(String name)` The name of a channel.
`Channel`	`withPrivacy(ChannelPrivacy privacy)` The channel's privacy setting.
`Channel`	`withPrivacy(String privacy)` The channel's privacy setting.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Channel
```
public Channel()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of a channel.
    
    Parameters:
    
    name - The name of a channel.
  - getName
```
public String getName()
```
    The name of a channel.
    
    Returns:
    
    The name of a channel.
  - withName
```
public Channel withName(String name)
```
    The name of a channel.
    
    Parameters:
    
    name - The name of a channel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setChannelArn
```
public void setChannelArn(String channelArn)
```
    The ARN of a channel.
    
    Parameters:
    
    channelArn - The ARN of a channel.
  - getChannelArn
```
public String getChannelArn()
```
    The ARN of a channel.
    
    Returns:
    
    The ARN of a channel.
  - withChannelArn
```
public Channel withChannelArn(String channelArn)
```
    The ARN of a channel.
    
    Parameters:
    
    channelArn - The ARN of a channel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMode
```
public void setMode(String mode)
```
    The mode of the channel.
    
    Parameters:
    
    mode - The mode of the channel.
    
    See Also:
    
    ChannelMode
  - getMode
```
public String getMode()
```
    The mode of the channel.
    
    Returns:
    
    The mode of the channel.
    
    See Also:
    
    ChannelMode
  - withMode
```
public Channel withMode(String mode)
```
    The mode of the channel.
    
    Parameters:
    
    mode - The mode of the channel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChannelMode
  - withMode
```
public Channel withMode(ChannelMode mode)
```
    The mode of the channel.
    
    Parameters:
    
    mode - The mode of the channel.
    
    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 setting.
    
    Parameters:
    
    privacy - The channel's privacy setting.
    
    See Also:
    
    ChannelPrivacy
  - getPrivacy
```
public String getPrivacy()
```
    The channel's privacy setting.
    
    Returns:
    
    The channel's privacy setting.
    
    See Also:
    
    ChannelPrivacy
  - withPrivacy
```
public Channel withPrivacy(String privacy)
```
    The channel's privacy setting.
    
    Parameters:
    
    privacy - The channel's privacy setting.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChannelPrivacy
  - withPrivacy
```
public Channel withPrivacy(ChannelPrivacy privacy)
```
    The channel's privacy setting.
    
    Parameters:
    
    privacy - The channel's privacy setting.
    
    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 channel's metadata.
    
    Parameters:
    
    metadata - The channel's metadata.
  - getMetadata
```
public String getMetadata()
```
    The channel's metadata.
    
    Returns:
    
    The channel's metadata.
  - withMetadata
```
public Channel withMetadata(String metadata)
```
    The channel's metadata.
    
    Parameters:
    
    metadata - The channel's metadata.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedBy
```
public void setCreatedBy(Identity createdBy)
```
    The AppInstanceUser who created the channel.
    
    Parameters:
    
    createdBy - The AppInstanceUser who created the channel.
  - getCreatedBy
```
public Identity getCreatedBy()
```
    The AppInstanceUser who created the channel.
    
    Returns:
    
    The AppInstanceUser who created the channel.
  - withCreatedBy
```
public Channel withCreatedBy(Identity createdBy)
```
    The AppInstanceUser who created the channel.
    
    Parameters:
    
    createdBy - The AppInstanceUser who created the channel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedTimestamp
```
public void setCreatedTimestamp(Date createdTimestamp)
```
    The time at which the AppInstanceUser created the channel.
    
    Parameters:
    
    createdTimestamp - The time at which the AppInstanceUser created the channel.
  - getCreatedTimestamp
```
public Date getCreatedTimestamp()
```
    The time at which the AppInstanceUser created the channel.
    
    Returns:
    
    The time at which the AppInstanceUser created the channel.
  - withCreatedTimestamp
```
public Channel withCreatedTimestamp(Date createdTimestamp)
```
    The time at which the AppInstanceUser created the channel.
    
    Parameters:
    
    createdTimestamp - The time at which the AppInstanceUser created the channel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastMessageTimestamp
```
public void setLastMessageTimestamp(Date lastMessageTimestamp)
```
    The time at which a member sent the last message in the channel.
    
    Parameters:
    
    lastMessageTimestamp - The time at which a member sent the last message in the channel.
  - getLastMessageTimestamp
```
public Date getLastMessageTimestamp()
```
    The time at which a member sent the last message in the channel.
    
    Returns:
    
    The time at which a member sent the last message in the channel.
  - withLastMessageTimestamp
```
public Channel withLastMessageTimestamp(Date lastMessageTimestamp)
```
    The time at which a member sent the last message in the channel.
    
    Parameters:
    
    lastMessageTimestamp - The time at which a member sent the last message in the channel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedTimestamp
```
public void setLastUpdatedTimestamp(Date lastUpdatedTimestamp)
```
    The time at which a channel was last updated.
    
    Parameters:
    
    lastUpdatedTimestamp - The time at which a channel was last updated.
  - getLastUpdatedTimestamp
```
public Date getLastUpdatedTimestamp()
```
    The time at which a channel was last updated.
    
    Returns:
    
    The time at which a channel was last updated.
  - withLastUpdatedTimestamp
```
public Channel withLastUpdatedTimestamp(Date lastUpdatedTimestamp)
```
    The time at which a channel was last updated.
    
    Parameters:
    
    lastUpdatedTimestamp - The time at which a channel was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setChannelFlowArn
```
public void setChannelFlowArn(String channelFlowArn)
```
    The ARN of the channel flow.
    
    Parameters:
    
    channelFlowArn - The ARN of the channel flow.
  - getChannelFlowArn
```
public String getChannelFlowArn()
```
    The ARN of the channel flow.
    
    Returns:
    
    The ARN of the channel flow.
  - withChannelFlowArn
```
public Channel withChannelFlowArn(String channelFlowArn)
```
    The ARN of the channel flow.
    
    Parameters:
    
    channelFlowArn - The ARN of the channel flow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setElasticChannelConfiguration
```
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 members.
    
    Parameters:
    
    elasticChannelConfiguration - The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.
  - getElasticChannelConfiguration
```
public ElasticChannelConfiguration getElasticChannelConfiguration()
```
    The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.
    
    Returns:
    
    The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.
  - withElasticChannelConfiguration
```
public Channel withElasticChannelConfiguration(ElasticChannelConfiguration elasticChannelConfiguration)
```
    The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.
    
    Parameters:
    
    elasticChannelConfiguration - The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExpirationSettings
```
public void setExpirationSettings(ExpirationSettings expirationSettings)
```
    Settings that control when a channel expires.
    
    Parameters:
    
    expirationSettings - Settings that control when a channel expires.
  - getExpirationSettings
```
public ExpirationSettings getExpirationSettings()
```
    Settings that control when a channel expires.
    
    Returns:
    
    Settings that control when a channel expires.
  - withExpirationSettings
```
public Channel withExpirationSettings(ExpirationSettings expirationSettings)
```
    Settings that control when a channel expires.
    
    Parameters:
    
    expirationSettings - Settings that control when a channel expires.
    
    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 Channel clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.777

Class Channel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Channel

Method Detail

setName

getName

withName

setChannelArn

getChannelArn

withChannelArn

setMode

getMode

withMode

withMode

setPrivacy

getPrivacy

withPrivacy

withPrivacy

setMetadata

getMetadata

withMetadata

setCreatedBy

getCreatedBy

withCreatedBy

setCreatedTimestamp

getCreatedTimestamp

withCreatedTimestamp

setLastMessageTimestamp

getLastMessageTimestamp

withLastMessageTimestamp

setLastUpdatedTimestamp

getLastUpdatedTimestamp

withLastUpdatedTimestamp

setChannelFlowArn

getChannelFlowArn

withChannelFlowArn

setElasticChannelConfiguration

getElasticChannelConfiguration

withElasticChannelConfiguration

setExpirationSettings

getExpirationSettings

withExpirationSettings

toString

equals

hashCode

clone

marshall