java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.kinesisvideo.model.KinesisVideoRequest
    - - software.amazon.awssdk.services.kinesisvideo.model.CreateStreamRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateStreamRequest.Builder,CreateStreamRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateStreamRequest
extends KinesisVideoRequest
implements ToCopyableBuilder<CreateStreamRequest.Builder,CreateStreamRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateStreamRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static CreateStreamRequest.Builder`	`builder()`
`Integer`	`dataRetentionInHours()`	The number of hours that you want to retain the data in the stream.
`String`	`deviceName()`	The name of the device that is writing to the stream.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`String`	`kmsKeyId()`	The ID of the Key Management Service (KMS) key that you want Kinesis Video Streams to use to encrypt stream data.
`String`	`mediaType()`	The media type of the stream.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateStreamRequest.Builder>`	`serializableBuilderClass()`
`String`	`streamName()`	A name for the stream that you are creating.
`Map<String,String>`	`tags()`	A list of tags to associate with the specified stream.
`CreateStreamRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - deviceName
```
public final 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:
    
    The name of the device that is writing to the stream.
    
    In the current implementation, Kinesis Video Streams does not use this name.
  - streamName
```
public final 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 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.
  - mediaType
```
public final 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:
    
    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).
  - kmsKeyId
```
public final 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.
    
    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.
  - dataRetentionInHours
```
public final 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:
    
    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.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final 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).
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).
  - toBuilder
```
public CreateStreamRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateStreamRequest.Builder,CreateStreamRequest>
    
    Specified by:
    
    toBuilder in class KinesisVideoRequest
  - builder
```
public static CreateStreamRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateStreamRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateStreamRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

deviceName

streamName

mediaType

kmsKeyId

dataRetentionInHours

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields