Channel (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.iotanalytics.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
```
A collection of data from an MQTT topic. Channels archive the raw, unprocessed messages before publishing the data to a pipeline.

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`	`getArn()` The ARN of the channel.
`Date`	`getCreationTime()` When the channel was created.
`Date`	`getLastUpdateTime()` When the channel was last updated.
`String`	`getName()` The name of the channel.
`RetentionPeriod`	`getRetentionPeriod()` How long, in days, message data is kept for the channel.
`String`	`getStatus()` The status of the channel.
`ChannelStorage`	`getStorage()` Where channel data is stored.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The ARN of the channel.
`void`	`setCreationTime(Date creationTime)` When the channel was created.
`void`	`setLastUpdateTime(Date lastUpdateTime)` When the channel was last updated.
`void`	`setName(String name)` The name of the channel.
`void`	`setRetentionPeriod(RetentionPeriod retentionPeriod)` How long, in days, message data is kept for the channel.
`void`	`setStatus(String status)` The status of the channel.
`void`	`setStorage(ChannelStorage storage)` Where channel data is stored.
`String`	`toString()` Returns a string representation of this object.
`Channel`	`withArn(String arn)` The ARN of the channel.
`Channel`	`withCreationTime(Date creationTime)` When the channel was created.
`Channel`	`withLastUpdateTime(Date lastUpdateTime)` When the channel was last updated.
`Channel`	`withName(String name)` The name of the channel.
`Channel`	`withRetentionPeriod(RetentionPeriod retentionPeriod)` How long, in days, message data is kept for the channel.
`Channel`	`withStatus(ChannelStatus status)` The status of the channel.
`Channel`	`withStatus(String status)` The status of the channel.
`Channel`	`withStorage(ChannelStorage storage)` Where channel data is stored.

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 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 Channel 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.
  - setStorage
```
public void setStorage(ChannelStorage storage)
```
    Where channel data is stored. You may choose one of "serviceManagedS3" or "customerManagedS3" storage. If not specified, the default is "serviceManagedS3". This cannot be changed after creation of the channel.
    
    Parameters:
    
    storage - Where channel data is stored. You may choose one of "serviceManagedS3" or "customerManagedS3" storage. If not specified, the default is "serviceManagedS3". This cannot be changed after creation of the channel.
  - getStorage
```
public ChannelStorage getStorage()
```
    Where channel data is stored. You may choose one of "serviceManagedS3" or "customerManagedS3" storage. If not specified, the default is "serviceManagedS3". This cannot be changed after creation of the channel.
    
    Returns:
    
    Where channel data is stored. You may choose one of "serviceManagedS3" or "customerManagedS3" storage. If not specified, the default is "serviceManagedS3". This cannot be changed after creation of the channel.
  - withStorage
```
public Channel withStorage(ChannelStorage storage)
```
    Where channel data is stored. You may choose one of "serviceManagedS3" or "customerManagedS3" storage. If not specified, the default is "serviceManagedS3". This cannot be changed after creation of the channel.
    
    Parameters:
    
    storage - Where channel data is stored. You may choose one of "serviceManagedS3" or "customerManagedS3" storage. If not specified, the default is "serviceManagedS3". This cannot be changed after creation of the channel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArn
```
public void setArn(String arn)
```
    The ARN of the channel.
    
    Parameters:
    
    arn - The ARN of the channel.
  - getArn
```
public String getArn()
```
    The ARN of the channel.
    
    Returns:
    
    The ARN of the channel.
  - withArn
```
public Channel withArn(String arn)
```
    The ARN of the channel.
    
    Parameters:
    
    arn - The ARN of the channel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of the channel.
    
    Parameters:
    
    status - The status of the channel.
    
    See Also:
    
    ChannelStatus
  - getStatus
```
public String getStatus()
```
    The status of the channel.
    
    Returns:
    
    The status of the channel.
    
    See Also:
    
    ChannelStatus
  - withStatus
```
public Channel withStatus(String status)
```
    The status of the channel.
    
    Parameters:
    
    status - The status of the channel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChannelStatus
  - withStatus
```
public Channel withStatus(ChannelStatus status)
```
    The status of the channel.
    
    Parameters:
    
    status - The status of the channel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChannelStatus
  - setRetentionPeriod
```
public void setRetentionPeriod(RetentionPeriod retentionPeriod)
```
    How long, in days, message data is kept for the channel.
    
    Parameters:
    
    retentionPeriod - How long, in days, message data is kept for the channel.
  - getRetentionPeriod
```
public RetentionPeriod getRetentionPeriod()
```
    How long, in days, message data is kept for the channel.
    
    Returns:
    
    How long, in days, message data is kept for the channel.
  - withRetentionPeriod
```
public Channel withRetentionPeriod(RetentionPeriod retentionPeriod)
```
    How long, in days, message data is kept for the channel.
    
    Parameters:
    
    retentionPeriod - How long, in days, message data is kept for the channel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    When the channel was created.
    
    Parameters:
    
    creationTime - When the channel was created.
  - getCreationTime
```
public Date getCreationTime()
```
    When the channel was created.
    
    Returns:
    
    When the channel was created.
  - withCreationTime
```
public Channel withCreationTime(Date creationTime)
```
    When the channel was created.
    
    Parameters:
    
    creationTime - When the channel was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdateTime
```
public void setLastUpdateTime(Date lastUpdateTime)
```
    When the channel was last updated.
    
    Parameters:
    
    lastUpdateTime - When the channel was last updated.
  - getLastUpdateTime
```
public Date getLastUpdateTime()
```
    When the channel was last updated.
    
    Returns:
    
    When the channel was last updated.
  - withLastUpdateTime
```
public Channel withLastUpdateTime(Date lastUpdateTime)
```
    When the channel was last updated.
    
    Parameters:
    
    lastUpdateTime - When the channel was last updated.
    
    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.

Did this page help you?

Class Channel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Channel

Method Detail

setName

getName

withName

setStorage

getStorage

withStorage

setArn

getArn

withArn

setStatus

getStatus

withStatus

withStatus

setRetentionPeriod

getRetentionPeriod

withRetentionPeriod

setCreationTime

getCreationTime

withCreationTime

setLastUpdateTime

getLastUpdateTime

withLastUpdateTime

toString

equals

hashCode

clone

marshall