@Generated(value="software.amazon.awssdk:codegen") public final class CreateStreamRequest extends KinesisVideoRequest implements ToCopyableBuilder<CreateStreamRequest.Builder,CreateStreamRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateStreamRequest.Builder |
| Modifier and Type | Method and 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.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic 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.
In the current implementation, Kinesis Video Streams does not use this name.
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.
The stream name is an identifier for the stream, and must be unique for each account and region.
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).
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).
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.
If no key ID is specified, the default, Kinesis Video-managed key (
Amazon Web Services/kinesisvideo) is used.
For more information, see DescribeKey.
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.
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.
public final boolean hasTags()
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.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.
public CreateStreamRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateStreamRequest.Builder,CreateStreamRequest>toBuilder in class KinesisVideoRequestpublic static CreateStreamRequest.Builder builder()
public static Class<? extends CreateStreamRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.