UpdateStreamRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.kinesisvideo.model.UpdateStreamRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class UpdateStreamRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
Updates stream metadata, such as the device name and media type.

You must provide the stream name or the Amazon Resource Name (ARN) of the stream.

To make sure that you have the latest version of the stream before updating it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API.

UpdateStream is an asynchronous operation, and takes time to complete.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

UpdateStreamRequest()

Constructors
Constructor and Description
`UpdateStreamRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getCurrentVersion()` The version of the stream whose metadata you want to update.
`java.lang.String`	`getDeviceName()` The name of the device that is writing to the stream.
`java.lang.String`	`getMediaType()` The stream's media type.
`java.lang.String`	`getStreamARN()` The ARN of the stream whose metadata you want to update.
`java.lang.String`	`getStreamName()` The name of the stream whose metadata you want to update.
`int`	`hashCode()`
`void`	`setCurrentVersion(java.lang.String currentVersion)` The version of the stream whose metadata you want to update.
`void`	`setDeviceName(java.lang.String deviceName)` The name of the device that is writing to the stream.
`void`	`setMediaType(java.lang.String mediaType)` The stream's media type.
`void`	`setStreamARN(java.lang.String streamARN)` The ARN of the stream whose metadata you want to update.
`void`	`setStreamName(java.lang.String streamName)` The name of the stream whose metadata you want to update.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`UpdateStreamRequest`	`withCurrentVersion(java.lang.String currentVersion)` The version of the stream whose metadata you want to update.
`UpdateStreamRequest`	`withDeviceName(java.lang.String deviceName)` The name of the device that is writing to the stream.
`UpdateStreamRequest`	`withMediaType(java.lang.String mediaType)` The stream's media type.
`UpdateStreamRequest`	`withStreamARN(java.lang.String streamARN)` The ARN of the stream whose metadata you want to update.
`UpdateStreamRequest`	`withStreamName(java.lang.String streamName)` The name of the stream whose metadata you want to update.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UpdateStreamRequest
```
public UpdateStreamRequest()
```
- Method Detail
  - getStreamName
```
public java.lang.String getStreamName()
```
    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.
    
    Constraints:
    Length: 1 - 256
    Pattern: [a-zA-Z0-9_.-]+
    
    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.
  - setStreamName
```
public void setStreamName(java.lang.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.
    
    Constraints:
    Length: 1 - 256
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    
    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.
  - withStreamName
```
public UpdateStreamRequest withStreamName(java.lang.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 a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 256
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getStreamARN
```
public java.lang.String getStreamARN()
```
    The ARN of the stream whose metadata you want to update.
    
    Constraints:
    Length: 1 - 1024
    Pattern: arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
    
    Returns:
    
    The ARN of the stream whose metadata you want to update.
  - setStreamARN
```
public void setStreamARN(java.lang.String streamARN)
```
    The ARN of the stream whose metadata you want to update.
    
    Constraints:
    Length: 1 - 1024
    Pattern: arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
    
    Parameters:
    
    streamARN -
    The ARN of the stream whose metadata you want to update.
  - withStreamARN
```
public UpdateStreamRequest withStreamARN(java.lang.String streamARN)
```
    The ARN of the stream whose metadata you want to update.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 1024
    Pattern: arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
    
    Parameters:
    
    streamARN -
    The ARN of the stream whose metadata you want to update.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getCurrentVersion
```
public java.lang.String getCurrentVersion()
```
    The version of the stream whose metadata you want to update.
    
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9]+
    
    Returns:
    
    The version of the stream whose metadata you want to update.
  - setCurrentVersion
```
public void setCurrentVersion(java.lang.String currentVersion)
```
    The version of the stream whose metadata you want to update.
    
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9]+
    
    Parameters:
    
    currentVersion -
    The version of the stream whose metadata you want to update.
  - withCurrentVersion
```
public UpdateStreamRequest withCurrentVersion(java.lang.String currentVersion)
```
    The version of the stream whose metadata you want to update.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9]+
    
    Parameters:
    
    currentVersion -
    The version of the stream whose metadata you want to update.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDeviceName
```
public java.lang.String getDeviceName()
```
    The name of the device that is writing to the stream.
    
    In the current implementation, Kinesis Video Streams does not use this name.
    
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Returns:
    
    The name of the device that is writing to the stream.
    
    In the current implementation, Kinesis Video Streams does not use this name.
  - setDeviceName
```
public void setDeviceName(java.lang.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.
    
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    
    deviceName -
    The name of the device that is writing to the stream.
    
    In the current implementation, Kinesis Video Streams does not use this name.
  - withDeviceName
```
public UpdateStreamRequest withDeviceName(java.lang.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 a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getMediaType
```
public java.lang.String getMediaType()
```
    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.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w\-\.\+]+/[\w\-\.\+]+(,[\w\-\.\+]+/[\w\-\.\+]+)*
    
    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.
  - setMediaType
```
public void setMediaType(java.lang.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.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w\-\.\+]+/[\w\-\.\+]+(,[\w\-\.\+]+/[\w\-\.\+]+)*
    
    Parameters:
    
    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.
  - withMediaType
```
public UpdateStreamRequest withMediaType(java.lang.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 a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [\w\-\.\+]+/[\w\-\.\+]+(,[\w\-\.\+]+/[\w\-\.\+]+)*
    
    Parameters:
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class UpdateStreamRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

UpdateStreamRequest

Method Detail

getStreamName

setStreamName

withStreamName

getStreamARN

setStreamARN

withStreamARN

getCurrentVersion

setCurrentVersion

withCurrentVersion

getDeviceName

setDeviceName

withDeviceName

getMediaType

setMediaType

withMediaType

toString

hashCode

equals