com.amazonaws.services.iot.model

Class CreateStreamRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.CreateStreamRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CreateStreamRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateStreamRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getDescription() A description of the stream.
java.util.List<StreamFile>	getFiles() The files to stream.
java.lang.String	getRoleArn() An IAM role that allows the IoT service principal assumes to access your S3 files.
java.lang.String	getStreamId() The stream ID.
java.util.List<Tag>	getTags() Metadata which can be used to manage streams.
int	hashCode()
void	setDescription(java.lang.String description) A description of the stream.
void	setFiles(java.util.Collection<StreamFile> files) The files to stream.
void	setRoleArn(java.lang.String roleArn) An IAM role that allows the IoT service principal assumes to access your S3 files.
void	setStreamId(java.lang.String streamId) The stream ID.
void	setTags(java.util.Collection<Tag> tags) Metadata which can be used to manage streams.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateStreamRequest	withDescription(java.lang.String description) A description of the stream.
CreateStreamRequest	withFiles(java.util.Collection<StreamFile> files) The files to stream.
CreateStreamRequest	withFiles(StreamFile... files) The files to stream.
CreateStreamRequest	withRoleArn(java.lang.String roleArn) An IAM role that allows the IoT service principal assumes to access your S3 files.
CreateStreamRequest	withStreamId(java.lang.String streamId) The stream ID.
CreateStreamRequest	withTags(java.util.Collection<Tag> tags) Metadata which can be used to manage streams.
CreateStreamRequest	withTags(Tag... tags) Metadata which can be used to manage streams.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateStreamRequest

public CreateStreamRequest()

Method Detail

getStreamId

public java.lang.String getStreamId()

The stream ID.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

Returns:

The stream ID.

setStreamId

public void setStreamId(java.lang.String streamId)

The stream ID.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

Parameters:

streamId -

The stream ID.

withStreamId

public CreateStreamRequest withStreamId(java.lang.String streamId)

The stream ID.

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

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

Parameters:

streamId -

The stream ID.

Returns:

A reference to this updated object so that method calls can be chained together.

getDescription

public java.lang.String getDescription()

A description of the stream.

Constraints:
Length: - 2028
Pattern: [^\p{C}]+

Returns:

A description of the stream.

setDescription

public void setDescription(java.lang.String description)

A description of the stream.

Constraints:
Length: - 2028
Pattern: [^\p{C}]+

Parameters:

description -

A description of the stream.

withDescription

public CreateStreamRequest withDescription(java.lang.String description)

A description of the stream.

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

Constraints:
Length: - 2028
Pattern: [^\p{C}]+

Parameters:

description -

A description of the stream.

Returns:

A reference to this updated object so that method calls can be chained together.

getFiles

public java.util.List<StreamFile> getFiles()

The files to stream.

Returns:

The files to stream.

setFiles

public void setFiles(java.util.Collection<StreamFile> files)

The files to stream.

Parameters:

files -

The files to stream.

withFiles

public CreateStreamRequest withFiles(StreamFile... files)

The files to stream.

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

Parameters:

files -

The files to stream.

Returns:

A reference to this updated object so that method calls can be chained together.

withFiles

public CreateStreamRequest withFiles(java.util.Collection<StreamFile> files)

The files to stream.

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

Parameters:

files -

The files to stream.

Returns:

A reference to this updated object so that method calls can be chained together.

getRoleArn

public java.lang.String getRoleArn()

An IAM role that allows the IoT service principal assumes to access your S3 files.

Constraints:
Length: 20 - 2048

Returns:

An IAM role that allows the IoT service principal assumes to access your S3 files.

setRoleArn

public void setRoleArn(java.lang.String roleArn)

An IAM role that allows the IoT service principal assumes to access your S3 files.

Constraints:
Length: 20 - 2048

Parameters:

roleArn -

An IAM role that allows the IoT service principal assumes to access your S3 files.

withRoleArn

public CreateStreamRequest withRoleArn(java.lang.String roleArn)

An IAM role that allows the IoT service principal assumes to access your S3 files.

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

Constraints:
Length: 20 - 2048

Parameters:

roleArn -

An IAM role that allows the IoT service principal assumes to access your S3 files.

Returns:

A reference to this updated object so that method calls can be chained together.

getTags

public java.util.List<Tag> getTags()

Metadata which can be used to manage streams.

Returns:

Metadata which can be used to manage streams.

setTags

public void setTags(java.util.Collection<Tag> tags)

Metadata which can be used to manage streams.

Parameters:

tags -

Metadata which can be used to manage streams.

withTags

public CreateStreamRequest withTags(Tag... tags)

Metadata which can be used to manage streams.

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

Parameters:

tags -

Metadata which can be used to manage streams.

Returns:

A reference to this updated object so that method calls can be chained together.

withTags

public CreateStreamRequest withTags(java.util.Collection<Tag> tags)

Metadata which can be used to manage streams.

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

Parameters:

tags -

Metadata which can be used to manage streams.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object