Class Image
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Image.Builder,
Image>
A structure that contains the Timestamp
, Error
, and ImageContent
.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Image.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final ImageError
error()
The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error.final String
The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
An attribute of theImage
object that is Base64 encoded.static Class
<? extends Image.Builder> final Instant
An attribute of theImage
object that is used to extract an image from the video stream.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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:
- 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.
-
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.
If the service returns an enum value that is not available in the current SDK version,
error
will returnImageError.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromerrorAsString()
.- 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:
-
-
errorAsString
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.
If the service returns an enum value that is not available in the current SDK version,
error
will returnImageError.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromerrorAsString()
.- 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:
-
-
imageContent
An attribute of the
Image
object that is Base64 encoded.- Returns:
- An attribute of the
Image
object that is Base64 encoded.
-
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 interfaceToCopyableBuilder<Image.Builder,
Image> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-