com.amazonaws.services.kinesisvideo.model

Class CreateStreamRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kinesisvideo.model.CreateStreamRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

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

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

CreateStreamRequest

public CreateStreamRequest()

Method Detail

setDeviceName

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

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.

getDeviceName

public 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.

Returns:

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(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.

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:

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

setStreamName

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

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.

getStreamName

public 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.

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.

withStreamName

public CreateStreamRequest withStreamName(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.

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:

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

setMediaType

public void setMediaType(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).

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).

getMediaType

public 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).

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).

withMediaType

public CreateStreamRequest withMediaType(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).

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:

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

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

The ID of the Key Management Service (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 (Amazon Web Services/kinesisvideo) is used.

For more information, see DescribeKey.

Parameters:

kmsKeyId - The ID of the Key Management Service (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 ( Amazon Web Services/kinesisvideo) is used.

For more information, see DescribeKey.

getKmsKeyId

public String getKmsKeyId()

The ID of the Key Management Service (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 (Amazon Web Services/kinesisvideo) is used.

For more information, see DescribeKey.

Returns:

The ID of the Key Management Service (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 ( Amazon Web Services/kinesisvideo) is used.

For more information, see DescribeKey.

withKmsKeyId

public CreateStreamRequest withKmsKeyId(String kmsKeyId)

The ID of the Key Management Service (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 (Amazon Web Services/kinesisvideo) is used.

For more information, see DescribeKey.

Parameters:

kmsKeyId - The ID of the Key Management Service (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 ( Amazon Web Services/kinesisvideo) is used.

For more information, see DescribeKey.

Returns:

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

setDataRetentionInHours

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

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.

getDataRetentionInHours

public 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.

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.

withDataRetentionInHours

public CreateStreamRequest withDataRetentionInHours(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.

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:

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

getTags

public Map<String,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(Map<String,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(Map<String,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).

Returns:

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

addTagsEntry

public CreateStreamRequest addTagsEntry(String key,
                                        String value)

Add a single Tags entry

See Also:

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

clearTagsEntries

public CreateStreamRequest clearTagsEntries()

Removes all the entries added into Tags.

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 CreateStreamRequest 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()