com.amazonaws.services.kinesisvideo.model

Class PutMediaRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kinesisvideo.model.PutMediaRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutMediaRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutMediaRequest()

Method Summary

Modifier and Type	Method and Description
PutMediaRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getFragmentTimecodeType() You pass this value as the x-amzn-fragment-timecode-type HTTP header.
InputStream	getPayload() The media content to write to the Kinesis video stream.
Date	getProducerStartTimestamp() You pass this value as the x-amzn-producer-start-timestamp HTTP header.
String	getStreamARN() You pass this value as the x-amzn-stream-arn HTTP header.
String	getStreamName() You pass this value as the x-amzn-stream-name HTTP header.
int	hashCode()
void	setFragmentTimecodeType(String fragmentTimecodeType) You pass this value as the x-amzn-fragment-timecode-type HTTP header.
void	setPayload(InputStream payload) The media content to write to the Kinesis video stream.
void	setProducerStartTimestamp(Date producerStartTimestamp) You pass this value as the x-amzn-producer-start-timestamp HTTP header.
void	setStreamARN(String streamARN) You pass this value as the x-amzn-stream-arn HTTP header.
void	setStreamName(String streamName) You pass this value as the x-amzn-stream-name HTTP header.
String	toString() Returns a string representation of this object.
PutMediaRequest	withFragmentTimecodeType(FragmentTimecodeType fragmentTimecodeType) You pass this value as the x-amzn-fragment-timecode-type HTTP header.
PutMediaRequest	withFragmentTimecodeType(String fragmentTimecodeType) You pass this value as the x-amzn-fragment-timecode-type HTTP header.
PutMediaRequest	withPayload(InputStream payload) The media content to write to the Kinesis video stream.
PutMediaRequest	withProducerStartTimestamp(Date producerStartTimestamp) You pass this value as the x-amzn-producer-start-timestamp HTTP header.
PutMediaRequest	withStreamARN(String streamARN) You pass this value as the x-amzn-stream-arn HTTP header.
PutMediaRequest	withStreamName(String streamName) You pass this value as the x-amzn-stream-name HTTP header.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutMediaRequest

public PutMediaRequest()

Method Detail

setStreamName

public void setStreamName(String streamName)

You pass this value as the x-amzn-stream-name HTTP header.

Name of the Kinesis video stream where you want to write the media content. If you don't specify the streamName, you must specify the streamARN.

Parameters:

streamName - You pass this value as the x-amzn-stream-name HTTP header.

Name of the Kinesis video stream where you want to write the media content. If you don't specify the streamName, you must specify the streamARN.

getStreamName

public String getStreamName()

You pass this value as the x-amzn-stream-name HTTP header.

Name of the Kinesis video stream where you want to write the media content. If you don't specify the streamName, you must specify the streamARN.

Returns:

You pass this value as the x-amzn-stream-name HTTP header.

Name of the Kinesis video stream where you want to write the media content. If you don't specify the streamName, you must specify the streamARN.

withStreamName

public PutMediaRequest withStreamName(String streamName)

You pass this value as the x-amzn-stream-name HTTP header.

Name of the Kinesis video stream where you want to write the media content. If you don't specify the streamName, you must specify the streamARN.

Parameters:

streamName - You pass this value as the x-amzn-stream-name HTTP header.

Name of the Kinesis video stream where you want to write the media content. If you don't specify the streamName, you must specify the streamARN.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStreamARN

public void setStreamARN(String streamARN)

You pass this value as the x-amzn-stream-arn HTTP header.

Amazon Resource Name (ARN) of the Kinesis video stream where you want to write the media content. If you don't specify the streamARN, you must specify the streamName.

Parameters:

streamARN - You pass this value as the x-amzn-stream-arn HTTP header.

Amazon Resource Name (ARN) of the Kinesis video stream where you want to write the media content. If you don't specify the streamARN, you must specify the streamName.

getStreamARN

public String getStreamARN()

You pass this value as the x-amzn-stream-arn HTTP header.

Amazon Resource Name (ARN) of the Kinesis video stream where you want to write the media content. If you don't specify the streamARN, you must specify the streamName.

Returns:

You pass this value as the x-amzn-stream-arn HTTP header.

Amazon Resource Name (ARN) of the Kinesis video stream where you want to write the media content. If you don't specify the streamARN, you must specify the streamName.

withStreamARN

public PutMediaRequest withStreamARN(String streamARN)

You pass this value as the x-amzn-stream-arn HTTP header.

Amazon Resource Name (ARN) of the Kinesis video stream where you want to write the media content. If you don't specify the streamARN, you must specify the streamName.

Parameters:

streamARN - You pass this value as the x-amzn-stream-arn HTTP header.

Amazon Resource Name (ARN) of the Kinesis video stream where you want to write the media content. If you don't specify the streamARN, you must specify the streamName.

Returns:

Returns a reference to this object so that method calls can be chained together.

setFragmentTimecodeType

public void setFragmentTimecodeType(String fragmentTimecodeType)

You pass this value as the x-amzn-fragment-timecode-type HTTP header.

Indicates whether timecodes in the fragments (payload, HTTP request body) are absolute or relative to producerStartTimestamp. Kinesis Video Streams uses this information to compute the producer_timestamp for the fragment received in the request, as described in the API overview.

Parameters:

fragmentTimecodeType - You pass this value as the x-amzn-fragment-timecode-type HTTP header.

Indicates whether timecodes in the fragments (payload, HTTP request body) are absolute or relative to producerStartTimestamp. Kinesis Video Streams uses this information to compute the producer_timestamp for the fragment received in the request, as described in the API overview.

See Also:

FragmentTimecodeType

getFragmentTimecodeType

public String getFragmentTimecodeType()

You pass this value as the x-amzn-fragment-timecode-type HTTP header.

Indicates whether timecodes in the fragments (payload, HTTP request body) are absolute or relative to producerStartTimestamp. Kinesis Video Streams uses this information to compute the producer_timestamp for the fragment received in the request, as described in the API overview.

Returns:

You pass this value as the x-amzn-fragment-timecode-type HTTP header.

Indicates whether timecodes in the fragments (payload, HTTP request body) are absolute or relative to producerStartTimestamp. Kinesis Video Streams uses this information to compute the producer_timestamp for the fragment received in the request, as described in the API overview.

See Also:

FragmentTimecodeType

withFragmentTimecodeType

public PutMediaRequest withFragmentTimecodeType(String fragmentTimecodeType)

You pass this value as the x-amzn-fragment-timecode-type HTTP header.

Indicates whether timecodes in the fragments (payload, HTTP request body) are absolute or relative to producerStartTimestamp. Kinesis Video Streams uses this information to compute the producer_timestamp for the fragment received in the request, as described in the API overview.

Parameters:

fragmentTimecodeType - You pass this value as the x-amzn-fragment-timecode-type HTTP header.

Indicates whether timecodes in the fragments (payload, HTTP request body) are absolute or relative to producerStartTimestamp. Kinesis Video Streams uses this information to compute the producer_timestamp for the fragment received in the request, as described in the API overview.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FragmentTimecodeType

withFragmentTimecodeType

public PutMediaRequest withFragmentTimecodeType(FragmentTimecodeType fragmentTimecodeType)

You pass this value as the x-amzn-fragment-timecode-type HTTP header.

Indicates whether timecodes in the fragments (payload, HTTP request body) are absolute or relative to producerStartTimestamp. Kinesis Video Streams uses this information to compute the producer_timestamp for the fragment received in the request, as described in the API overview.

Parameters:

fragmentTimecodeType - You pass this value as the x-amzn-fragment-timecode-type HTTP header.

Indicates whether timecodes in the fragments (payload, HTTP request body) are absolute or relative to producerStartTimestamp. Kinesis Video Streams uses this information to compute the producer_timestamp for the fragment received in the request, as described in the API overview.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FragmentTimecodeType

setProducerStartTimestamp

public void setProducerStartTimestamp(Date producerStartTimestamp)

You pass this value as the x-amzn-producer-start-timestamp HTTP header.

This is the producer time stamp at which the producer started recording the media (not the time stamp of the specific fragments in the request).

Parameters:

producerStartTimestamp - You pass this value as the x-amzn-producer-start-timestamp HTTP header.

This is the producer time stamp at which the producer started recording the media (not the time stamp of the specific fragments in the request).

getProducerStartTimestamp

public Date getProducerStartTimestamp()

You pass this value as the x-amzn-producer-start-timestamp HTTP header.

This is the producer time stamp at which the producer started recording the media (not the time stamp of the specific fragments in the request).

Returns:

You pass this value as the x-amzn-producer-start-timestamp HTTP header.

This is the producer time stamp at which the producer started recording the media (not the time stamp of the specific fragments in the request).

withProducerStartTimestamp

public PutMediaRequest withProducerStartTimestamp(Date producerStartTimestamp)

You pass this value as the x-amzn-producer-start-timestamp HTTP header.

This is the producer time stamp at which the producer started recording the media (not the time stamp of the specific fragments in the request).

Parameters:

producerStartTimestamp - You pass this value as the x-amzn-producer-start-timestamp HTTP header.

This is the producer time stamp at which the producer started recording the media (not the time stamp of the specific fragments in the request).

Returns:

Returns a reference to this object so that method calls can be chained together.

setPayload

public void setPayload(InputStream payload)

The media content to write to the Kinesis video stream. In the current implementation, Kinesis Video Streams supports only the Matroska (MKV) container format with a single MKV segment. A segment can contain one or more clusters.

Each MKV cluster maps to a Kinesis video stream fragment. Whatever cluster duration you choose becomes the fragment duration.

Parameters:

payload - The media content to write to the Kinesis video stream. In the current implementation, Kinesis Video Streams supports only the Matroska (MKV) container format with a single MKV segment. A segment can contain one or more clusters.

Each MKV cluster maps to a Kinesis video stream fragment. Whatever cluster duration you choose becomes the fragment duration.

getPayload

public InputStream getPayload()

The media content to write to the Kinesis video stream. In the current implementation, Kinesis Video Streams supports only the Matroska (MKV) container format with a single MKV segment. A segment can contain one or more clusters.

Each MKV cluster maps to a Kinesis video stream fragment. Whatever cluster duration you choose becomes the fragment duration.

Returns:

The media content to write to the Kinesis video stream. In the current implementation, Kinesis Video Streams supports only the Matroska (MKV) container format with a single MKV segment. A segment can contain one or more clusters.

Each MKV cluster maps to a Kinesis video stream fragment. Whatever cluster duration you choose becomes the fragment duration.

withPayload

public PutMediaRequest withPayload(InputStream payload)

The media content to write to the Kinesis video stream. In the current implementation, Kinesis Video Streams supports only the Matroska (MKV) container format with a single MKV segment. A segment can contain one or more clusters.

Each MKV cluster maps to a Kinesis video stream fragment. Whatever cluster duration you choose becomes the fragment duration.

Parameters:

payload - The media content to write to the Kinesis video stream. In the current implementation, Kinesis Video Streams supports only the Matroska (MKV) container format with a single MKV segment. A segment can contain one or more clusters.

Each MKV cluster maps to a Kinesis video stream fragment. Whatever cluster duration you choose becomes the fragment duration.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public PutMediaRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()