Class CreateStreamRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateStreamRequest.Builder,
CreateStreamRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic CreateStreamRequest.Builder
builder()
final Integer
The number of hours that you want to retain the data in the stream.final String
The name of the device that is writing to the stream.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
kmsKeyId()
The ID of the Key Management Service (KMS) key that you want Kinesis Video Streams to use to encrypt stream data.final String
The media type of the stream.static Class
<? extends CreateStreamRequest.Builder> final String
A name for the stream that you are creating.tags()
A list of tags to associate with the specified stream.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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
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
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 theisEmpty()
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateStreamRequest.Builder,
CreateStreamRequest> - Specified by:
toBuilder
in classKinesisVideoRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-