com.amazonaws.services.kinesisvideo.model

Class CreateStreamRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kinesisvideo.model.CreateStreamRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CreateStreamRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Creates a new Kinesis video stream.

When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream's metadata, Kinesis Video Streams updates the version.

CreateStream is an asynchronous operation.

For information about how the service works, see How it Works.

You must have permissions for the KinesisVideo:CreateStream action.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateStreamRequest()

Method Summary

Modifier and Type	Method and Description
CreateStreamRequest	addTagsEntry(java.lang.String key, java.lang.String value) A list of tags to associate with the specified stream.
CreateStreamRequest	clearTagsEntries() Removes all the entries added into Tags.
boolean	equals(java.lang.Object obj)
java.lang.Integer	getDataRetentionInHours() The number of hours that you want to retain the data in the stream.
java.lang.String	getDeviceName() The name of the device that is writing to the stream.
java.lang.String	getKmsKeyId() The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis Video Streams to use to encrypt stream data.
java.lang.String	getMediaType() The media type of the stream.
java.lang.String	getStreamName() A name for the stream that you are creating.
java.util.Map<java.lang.String,java.lang.String>	getTags() A list of tags to associate with the specified stream.
int	hashCode()
void	setDataRetentionInHours(java.lang.Integer dataRetentionInHours) The number of hours that you want to retain the data in the stream.
void	setDeviceName(java.lang.String deviceName) The name of the device that is writing to the stream.
void	setKmsKeyId(java.lang.String kmsKeyId) The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis Video Streams to use to encrypt stream data.
void	setMediaType(java.lang.String mediaType) The media type of the stream.
void	setStreamName(java.lang.String streamName) A name for the stream that you are creating.
void	setTags(java.util.Map<java.lang.String,java.lang.String> tags) A list of tags to associate with the specified stream.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateStreamRequest	withDataRetentionInHours(java.lang.Integer dataRetentionInHours) The number of hours that you want to retain the data in the stream.
CreateStreamRequest	withDeviceName(java.lang.String deviceName) The name of the device that is writing to the stream.
CreateStreamRequest	withKmsKeyId(java.lang.String kmsKeyId) The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis Video Streams to use to encrypt stream data.
CreateStreamRequest	withMediaType(java.lang.String mediaType) The media type of the stream.
CreateStreamRequest	withStreamName(java.lang.String streamName) A name for the stream that you are creating.
CreateStreamRequest	withTags(java.util.Map<java.lang.String,java.lang.String> tags) A list of tags to associate with the specified stream.

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

getDeviceName

public java.lang.String getDeviceName()

The name of the device that is writing to the stream.

In the current implementation, Kinesis Video Streams does not use this name.

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

Returns:

The name of the device that is writing to the stream.

In the current implementation, Kinesis Video Streams does not use this name.

setDeviceName

public void setDeviceName(java.lang.String deviceName)

The name of the device that is writing to the stream.

In the current implementation, Kinesis Video Streams does not use this name.

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

Parameters:

deviceName -

The name of the device that is writing to the stream.

In the current implementation, Kinesis Video Streams does not use this name.

withDeviceName

public CreateStreamRequest withDeviceName(java.lang.String deviceName)

The name of the device that is writing to the stream.

In the current implementation, Kinesis Video Streams does not use this name.

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

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

Parameters:

deviceName -

The name of the device that is writing to the stream.

In the current implementation, Kinesis Video Streams does not use this name.

Returns:

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

getStreamName

public java.lang.String getStreamName()

A name for the stream that you are creating.

The stream name is an identifier for the stream, and must be unique for each account and region.

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

Returns:

A name for the stream that you are creating.

The stream name is an identifier for the stream, and must be unique for each account and region.

setStreamName

public void setStreamName(java.lang.String streamName)

A name for the stream that you are creating.

The stream name is an identifier for the stream, and must be unique for each account and region.

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

Parameters:

streamName -

A name for the stream that you are creating.

The stream name is an identifier for the stream, and must be unique for each account and region.

withStreamName

public CreateStreamRequest withStreamName(java.lang.String streamName)

A name for the stream that you are creating.

The stream name is an identifier for the stream, and must be unique for each account and region.

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

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

Parameters:

streamName -

A name for the stream that you are creating.

The stream name is an identifier for the stream, and must be unique for each account and region.

Returns:

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

getMediaType

public java.lang.String getMediaType()

The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements for guidelines.

Example valid values include "video/h264" and "video/h264,audio/aac".

This parameter is optional; the default value is null (or empty in JSON).

Constraints:
Length: 1 - 128
Pattern: [\w\-\.\+]+/[\w\-\.\+]+(,[\w\-\.\+]+/[\w\-\.\+]+)*

Returns:

The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements for guidelines.

Example valid values include "video/h264" and "video/h264,audio/aac".

This parameter is optional; the default value is null (or empty in JSON).

setMediaType

public void setMediaType(java.lang.String mediaType)

The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements for guidelines.

Example valid values include "video/h264" and "video/h264,audio/aac".

This parameter is optional; the default value is null (or empty in JSON).

Constraints:
Length: 1 - 128
Pattern: [\w\-\.\+]+/[\w\-\.\+]+(,[\w\-\.\+]+/[\w\-\.\+]+)*

Parameters:

mediaType -

The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements for guidelines.

Example valid values include "video/h264" and "video/h264,audio/aac".

This parameter is optional; the default value is null (or empty in JSON).

withMediaType

public CreateStreamRequest withMediaType(java.lang.String mediaType)

The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements for guidelines.

Example valid values include "video/h264" and "video/h264,audio/aac".

This parameter is optional; the default value is null (or empty in JSON).

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

Constraints:
Length: 1 - 128
Pattern: [\w\-\.\+]+/[\w\-\.\+]+(,[\w\-\.\+]+/[\w\-\.\+]+)*

Parameters:

mediaType -

The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements for guidelines.

Example valid values include "video/h264" and "video/h264,audio/aac".

This parameter is optional; the default value is null (or empty in JSON).

Returns:

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

getKmsKeyId

public java.lang.String getKmsKeyId()

The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis Video Streams to use to encrypt stream data.

If no key ID is specified, the default, Kinesis Video-managed key ( aws/kinesisvideo) is used.

For more information, see DescribeKey.

Constraints:
Length: 1 - 2048

Returns:

The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis Video Streams to use to encrypt stream data.

If no key ID is specified, the default, Kinesis Video-managed key (aws/kinesisvideo) is used.

For more information, see DescribeKey.

setKmsKeyId

public void setKmsKeyId(java.lang.String kmsKeyId)

The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis Video Streams to use to encrypt stream data.

If no key ID is specified, the default, Kinesis Video-managed key ( aws/kinesisvideo) is used.

For more information, see DescribeKey.

Constraints:
Length: 1 - 2048

Parameters:

kmsKeyId -

The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis Video Streams to use to encrypt stream data.

If no key ID is specified, the default, Kinesis Video-managed key (aws/kinesisvideo) is used.

For more information, see DescribeKey.

withKmsKeyId

public CreateStreamRequest withKmsKeyId(java.lang.String kmsKeyId)

The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis Video Streams to use to encrypt stream data.

If no key ID is specified, the default, Kinesis Video-managed key ( aws/kinesisvideo) is used.

For more information, see DescribeKey.

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

Constraints:
Length: 1 - 2048

Parameters:

kmsKeyId -

The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis Video Streams to use to encrypt stream data.

If no key ID is specified, the default, Kinesis Video-managed key (aws/kinesisvideo) is used.

For more information, see DescribeKey.

Returns:

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

getDataRetentionInHours

public java.lang.Integer getDataRetentionInHours()

The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

The default value is 0, indicating that the stream does not persist data.

When the DataRetentionInHours value is 0, consumers can still consume the fragments that remain in the service host buffer, which has a retention time limit of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the buffer when either limit is reached.

Constraints:
Range: 0 -

Returns:

The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

The default value is 0, indicating that the stream does not persist data.

When the DataRetentionInHours value is 0, consumers can still consume the fragments that remain in the service host buffer, which has a retention time limit of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the buffer when either limit is reached.

setDataRetentionInHours

public void setDataRetentionInHours(java.lang.Integer dataRetentionInHours)

The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

The default value is 0, indicating that the stream does not persist data.

When the DataRetentionInHours value is 0, consumers can still consume the fragments that remain in the service host buffer, which has a retention time limit of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the buffer when either limit is reached.

Constraints:
Range: 0 -

Parameters:

dataRetentionInHours -

The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

The default value is 0, indicating that the stream does not persist data.

When the DataRetentionInHours value is 0, consumers can still consume the fragments that remain in the service host buffer, which has a retention time limit of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the buffer when either limit is reached.

withDataRetentionInHours

public CreateStreamRequest withDataRetentionInHours(java.lang.Integer dataRetentionInHours)

The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

The default value is 0, indicating that the stream does not persist data.

When the DataRetentionInHours value is 0, consumers can still consume the fragments that remain in the service host buffer, which has a retention time limit of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the buffer when either limit is reached.

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

Constraints:
Range: 0 -

Parameters:

dataRetentionInHours -

The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

The default value is 0, indicating that the stream does not persist data.

When the DataRetentionInHours value is 0, consumers can still consume the fragments that remain in the service host buffer, which has a retention time limit of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the buffer when either limit is reached.

Returns:

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

getTags

public java.util.Map<java.lang.String,java.lang.String> getTags()

A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

Returns:

A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

setTags

public void setTags(java.util.Map<java.lang.String,java.lang.String> tags)

A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

Parameters:

tags -

A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

withTags

public CreateStreamRequest withTags(java.util.Map<java.lang.String,java.lang.String> tags)

A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

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

Parameters:

tags -

A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

Returns:

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

addTagsEntry

public CreateStreamRequest addTagsEntry(java.lang.String key,
                                        java.lang.String value)

A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

The method adds a new key-value pair into Tags parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into Tags.

value - The corresponding value of the entry to be added into Tags.

Returns:

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

clearTagsEntries

public CreateStreamRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns a reference to this 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