Package software.amazon.awssdk.services.kinesisvideo.model

Class UpdateStreamRequest

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.UpdateStreamRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateStreamRequest.Builder,UpdateStreamRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateStreamRequest extends KinesisVideoRequest implements ToCopyableBuilder<UpdateStreamRequest.Builder,UpdateStreamRequest>

  • Method Details

    • streamName

      public final String streamName()

      The name of the stream whose metadata you want to update.

      The stream name is an identifier for the stream, and must be unique for each account and region.

      Returns:
      The name of the stream whose metadata you want to update.

      The stream name is an identifier for the stream, and must be unique for each account and region.

    • streamARN

      public final String streamARN()

      The ARN of the stream whose metadata you want to update.

      Returns:
      The ARN of the stream whose metadata you want to update.

    • currentVersion

      public final String currentVersion()

      The version of the stream whose metadata you want to update.

      Returns:
      The version of the stream whose metadata you want to update.

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

    • mediaType

      public final String mediaType()

      The stream's media type. Use MediaType to specify the type of content that the stream contains to the consumers of the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements.

      To play video on the console, you must specify the correct video type. For example, if the video in the stream is H.264, specify video/h264 as the MediaType.

      Returns:
      The stream's media type. Use MediaType to specify the type of content that the stream contains to the consumers of the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements.

      To play video on the console, you must specify the correct video type. For example, if the video in the stream is H.264, specify video/h264 as the MediaType.

    • toBuilder

      public UpdateStreamRequest.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<UpdateStreamRequest.Builder,UpdateStreamRequest>
      Specified by:
      toBuilder in class KinesisVideoRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateStreamRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateStreamRequest.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.