Class CreateStreamRequest

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>

  • Method Details

    • 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()
      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 interface ToCopyableBuilder<CreateStreamRequest.Builder,CreateStreamRequest>
      Specified by:
      toBuilder in class KinesisVideoRequest
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.