com.amazonaws.services.kinesisvideo.model

Class Image

java.lang.Object

com.amazonaws.services.kinesisvideo.model.Image

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

A structure that contains the Timestamp, Error, and ImageContent.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Image()

Method Summary

Modifier and Type	Method and Description
Image	clone()
boolean	equals(Object obj)
String	getError() The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error.
String	getImageContent() An attribute of the Image object that is Base64 encoded.
Date	getTimeStamp() An attribute of the Image object that is used to extract an image from the video stream.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setError(String error) The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error.
void	setImageContent(String imageContent) An attribute of the Image object that is Base64 encoded.
void	setTimeStamp(Date timeStamp) An attribute of the Image object that is used to extract an image from the video stream.
String	toString() Returns a string representation of this object.
Image	withError(ImageError error) The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error.
Image	withError(String error) The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error.
Image	withImageContent(String imageContent) An attribute of the Image object that is Base64 encoded.
Image	withTimeStamp(Date timeStamp) An attribute of the Image object that is used to extract an image from the video stream.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Image

public Image()

Method Detail

setTimeStamp

public void setTimeStamp(Date timeStamp)

An attribute of the Image object that is used to extract an image from the video stream. This field is used to manage gaps on images or to better understand the pagination window.

Parameters:

timeStamp - An attribute of the Image object that is used to extract an image from the video stream. This field is used to manage gaps on images or to better understand the pagination window.

getTimeStamp

public Date getTimeStamp()

An attribute of the Image object that is used to extract an image from the video stream. This field is used to manage gaps on images or to better understand the pagination window.

Returns:

An attribute of the Image object that is used to extract an image from the video stream. This field is used to manage gaps on images or to better understand the pagination window.

withTimeStamp

public Image withTimeStamp(Date timeStamp)

An attribute of the Image object that is used to extract an image from the video stream. This field is used to manage gaps on images or to better understand the pagination window.

Parameters:

timeStamp - An attribute of the Image object that is used to extract an image from the video stream. This field is used to manage gaps on images or to better understand the pagination window.

Returns:

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

setError

public void setError(String error)

The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:

• There is no media that exists for the specified Timestamp.

• The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect media has been ingested.

Parameters:

error - The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:

• There is no media that exists for the specified Timestamp.

• The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect media has been ingested.

See Also:

ImageError

getError

public String getError()

The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:

• There is no media that exists for the specified Timestamp.

• The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect media has been ingested.

Returns:

The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:

• There is no media that exists for the specified Timestamp.

• The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect media has been ingested.

See Also:

ImageError

withError

public Image withError(String error)

The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:

• There is no media that exists for the specified Timestamp.

• The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect media has been ingested.

Parameters:

error - The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:

• There is no media that exists for the specified Timestamp.

• The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect media has been ingested.

Returns:

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

See Also:

ImageError

withError

public Image withError(ImageError error)

The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:

• There is no media that exists for the specified Timestamp.

• The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect media has been ingested.

Parameters:

error - The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:

• There is no media that exists for the specified Timestamp.

• The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect media has been ingested.

Returns:

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

See Also:

ImageError

setImageContent

public void setImageContent(String imageContent)

An attribute of the Image object that is Base64 encoded.

Parameters:

imageContent - An attribute of the Image object that is Base64 encoded.

getImageContent

public String getImageContent()

An attribute of the Image object that is Base64 encoded.

Returns:

An attribute of the Image object that is Base64 encoded.

withImageContent

public Image withImageContent(String imageContent)

An attribute of the Image object that is Base64 encoded.

Parameters:

imageContent - An attribute of the Image object that is Base64 encoded.

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 Image clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.