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:

ToCopyableBuilder<UpdateStreamRequest.Builder,UpdateStreamRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateStreamRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateStreamRequest.Builder	builder()
String	currentVersion() The version of the stream whose metadata you want to update.
String	deviceName() The name of the device that is writing to the stream.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	mediaType() The stream's media type.
static Class<? extends UpdateStreamRequest.Builder>	serializableBuilderClass()
String	streamARN() The ARN of the stream whose metadata you want to update.
String	streamName() The name of the stream whose metadata you want to update.
UpdateStreamRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

streamName

public 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 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 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 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 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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <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