software.amazon.awssdk.services.kinesisvideo.model

Class ImageGenerationConfiguration

java.lang.Object

software.amazon.awssdk.services.kinesisvideo.model.ImageGenerationConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ImageGenerationConfiguration.Builder,ImageGenerationConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class ImageGenerationConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ImageGenerationConfiguration.Builder,ImageGenerationConfiguration>

The structure that contains the information required for the KVS images delivery. If null, the configuration will be deleted from the stream.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ImageGenerationConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static ImageGenerationConfiguration.Builder	builder()
ImageGenerationDestinationConfig	destinationConfig() The structure that contains the information required to deliver images to a customer.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Format	format() The accepted image format.
String	formatAsString() The accepted image format.
Map<FormatConfigKey,String>	formatConfig() The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated.
Map<String,String>	formatConfigAsStrings() The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFormatConfig() For responses, this returns true if the service returned a value for the FormatConfig property.
int	hashCode()
Integer	heightPixels() The height of the output image that is used in conjunction with the WidthPixels parameter.
ImageSelectorType	imageSelectorType() The origin of the Server or Producer timestamps to use to generate the images.
String	imageSelectorTypeAsString() The origin of the Server or Producer timestamps to use to generate the images.
Integer	samplingInterval() The time interval in milliseconds (ms) at which the images need to be generated from the stream.
List<SdkField<?>>	sdkFields()
static Class<? extends ImageGenerationConfiguration.Builder>	serializableBuilderClass()
ConfigurationStatus	status() Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.
String	statusAsString() Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.
ImageGenerationConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Integer	widthPixels() The width of the output image that is used in conjunction with the HeightPixels parameter.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

status

public final ConfigurationStatus status()

Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.

If the service returns an enum value that is not available in the current SDK version, status will return ConfigurationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.

See Also:

ConfigurationStatus

statusAsString

public final String statusAsString()

Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.

If the service returns an enum value that is not available in the current SDK version, status will return ConfigurationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.

See Also:

ConfigurationStatus

imageSelectorType

public final ImageSelectorType imageSelectorType()

The origin of the Server or Producer timestamps to use to generate the images.

If the service returns an enum value that is not available in the current SDK version, imageSelectorType will return ImageSelectorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from imageSelectorTypeAsString().

Returns:

The origin of the Server or Producer timestamps to use to generate the images.

See Also:

ImageSelectorType

imageSelectorTypeAsString

public final String imageSelectorTypeAsString()

The origin of the Server or Producer timestamps to use to generate the images.

If the service returns an enum value that is not available in the current SDK version, imageSelectorType will return ImageSelectorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from imageSelectorTypeAsString().

Returns:

The origin of the Server or Producer timestamps to use to generate the images.

See Also:

ImageSelectorType

destinationConfig

public final ImageGenerationDestinationConfig destinationConfig()

The structure that contains the information required to deliver images to a customer.

Returns:

The structure that contains the information required to deliver images to a customer.

samplingInterval

public final Integer samplingInterval()

The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 33 ms, because a camera that generates content at 30 FPS would create a frame every 33.3 ms. If the timestamp range is less than the sampling interval, the Image from the StartTimestamp will be returned if available.

Returns:

The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 33 ms, because a camera that generates content at 30 FPS would create a frame every 33.3 ms. If the timestamp range is less than the sampling interval, the Image from the StartTimestamp will be returned if available.

format

public final Format format()

The accepted image format.

If the service returns an enum value that is not available in the current SDK version, format will return Format.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().

Returns:

The accepted image format.

See Also:

Format

formatAsString

public final String formatAsString()

The accepted image format.

If the service returns an enum value that is not available in the current SDK version, format will return Format.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().

Returns:

The accepted image format.

See Also:

Format

formatConfig

public final Map<FormatConfigKey,String> formatConfig()

The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFormatConfig() method.

Returns:

The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.

hasFormatConfig

public final boolean hasFormatConfig()

For responses, this returns true if the service returned a value for the FormatConfig property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

formatConfigAsStrings

public final Map<String,String> formatConfigAsStrings()

The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFormatConfig() method.

Returns:

The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.

widthPixels

public final Integer widthPixels()

The width of the output image that is used in conjunction with the HeightPixels parameter. When both WidthPixels and HeightPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the WidthPixels parameter is provided, its original aspect ratio will be used to calculate the HeightPixels ratio. If neither parameter is provided, the original image size will be returned.

Returns:

The width of the output image that is used in conjunction with the HeightPixels parameter. When both WidthPixels and HeightPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the WidthPixels parameter is provided, its original aspect ratio will be used to calculate the HeightPixels ratio. If neither parameter is provided, the original image size will be returned.

heightPixels

public final Integer heightPixels()

The height of the output image that is used in conjunction with the WidthPixels parameter. When both HeightPixels and WidthPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the HeightPixels parameter is provided, its original aspect ratio will be used to calculate the WidthPixels ratio. If neither parameter is provided, the original image size will be returned.

Returns:

The height of the output image that is used in conjunction with the WidthPixels parameter. When both HeightPixels and WidthPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the HeightPixels parameter is provided, its original aspect ratio will be used to calculate the WidthPixels ratio. If neither parameter is provided, the original image size will be returned.

toBuilder

public ImageGenerationConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ImageGenerationConfiguration.Builder,ImageGenerationConfiguration>

builder

public static ImageGenerationConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends ImageGenerationConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo