Interface ImageGenerationConfiguration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ImageGenerationConfiguration.Builder,
,ImageGenerationConfiguration> SdkBuilder<ImageGenerationConfiguration.Builder,
,ImageGenerationConfiguration> SdkPojo
- Enclosing class:
ImageGenerationConfiguration
-
Method Summary
Modifier and TypeMethodDescriptiondestinationConfig
(Consumer<ImageGenerationDestinationConfig.Builder> destinationConfig) The structure that contains the information required to deliver images to a customer.destinationConfig
(ImageGenerationDestinationConfig destinationConfig) The structure that contains the information required to deliver images to a customer.The accepted image format.The accepted image format.formatConfig
(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.formatConfigWithStrings
(Map<String, String> formatConfig) The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated.heightPixels
(Integer heightPixels) The height of the output image that is used in conjunction with theWidthPixels
parameter.imageSelectorType
(String imageSelectorType) The origin of the Server or Producer timestamps to use to generate the images.imageSelectorType
(ImageSelectorType imageSelectorType) The origin of the Server or Producer timestamps to use to generate the images.samplingInterval
(Integer samplingInterval) The time interval in milliseconds (ms) at which the images need to be generated from the stream.Indicates whether theContinuousImageGenerationConfigurations
API is enabled or disabled.status
(ConfigurationStatus status) Indicates whether theContinuousImageGenerationConfigurations
API is enabled or disabled.widthPixels
(Integer widthPixels) The width of the output image that is used in conjunction with theHeightPixels
parameter.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
status
Indicates whether the
ContinuousImageGenerationConfigurations
API is enabled or disabled.- Parameters:
status
- Indicates whether theContinuousImageGenerationConfigurations
API is enabled or disabled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
Indicates whether the
ContinuousImageGenerationConfigurations
API is enabled or disabled.- Parameters:
status
- Indicates whether theContinuousImageGenerationConfigurations
API is enabled or disabled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
imageSelectorType
The origin of the Server or Producer timestamps to use to generate the images.
- Parameters:
imageSelectorType
- The origin of the Server or Producer timestamps to use to generate the images.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
imageSelectorType
The origin of the Server or Producer timestamps to use to generate the images.
- Parameters:
imageSelectorType
- The origin of the Server or Producer timestamps to use to generate the images.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
destinationConfig
ImageGenerationConfiguration.Builder destinationConfig(ImageGenerationDestinationConfig destinationConfig) The structure that contains the information required to deliver images to a customer.
- Parameters:
destinationConfig
- The structure that contains the information required to deliver images to a customer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
destinationConfig
default ImageGenerationConfiguration.Builder destinationConfig(Consumer<ImageGenerationDestinationConfig.Builder> destinationConfig) The structure that contains the information required to deliver images to a customer.
This is a convenience method that creates an instance of theImageGenerationDestinationConfig.Builder
avoiding the need to create one manually viaImageGenerationDestinationConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todestinationConfig(ImageGenerationDestinationConfig)
.- Parameters:
destinationConfig
- a consumer that will call methods onImageGenerationDestinationConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 200 ms. If the timestamp range is less than the sampling interval, the Image from the
StartTimestamp
will be returned if available.- Parameters:
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 200 ms. If the timestamp range is less than the sampling interval, the Image from theStartTimestamp
will be returned if available.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
format
The accepted image format.
- Parameters:
format
- The accepted image format.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
format
The accepted image format.
- Parameters:
format
- The accepted image format.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
formatConfigWithStrings
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 theJPEGQuality
, which indicates the JPEG quality key to be used to generate the image. TheFormatConfig
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 theJPEGQuality
key will be set to 80.- Parameters:
formatConfig
- The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. TheFormatConfig
key is theJPEGQuality
, which indicates the JPEG quality key to be used to generate the image. TheFormatConfig
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 theJPEGQuality
key will be set to 80.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 theJPEGQuality
, which indicates the JPEG quality key to be used to generate the image. TheFormatConfig
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 theJPEGQuality
key will be set to 80.- Parameters:
formatConfig
- The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. TheFormatConfig
key is theJPEGQuality
, which indicates the JPEG quality key to be used to generate the image. TheFormatConfig
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 theJPEGQuality
key will be set to 80.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
widthPixels
The width of the output image that is used in conjunction with the
HeightPixels
parameter. When bothWidthPixels
andHeightPixels
parameters are provided, the image will be stretched to fit the specified aspect ratio. If only theWidthPixels
parameter is provided, its original aspect ratio will be used to calculate theHeightPixels
ratio. If neither parameter is provided, the original image size will be returned.- Parameters:
widthPixels
- The width of the output image that is used in conjunction with theHeightPixels
parameter. When bothWidthPixels
andHeightPixels
parameters are provided, the image will be stretched to fit the specified aspect ratio. If only theWidthPixels
parameter is provided, its original aspect ratio will be used to calculate theHeightPixels
ratio. If neither parameter is provided, the original image size will be returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
heightPixels
The height of the output image that is used in conjunction with the
WidthPixels
parameter. When bothHeightPixels
andWidthPixels
parameters are provided, the image will be stretched to fit the specified aspect ratio. If only theHeightPixels
parameter is provided, its original aspect ratio will be used to calculate theWidthPixels
ratio. If neither parameter is provided, the original image size will be returned.- Parameters:
heightPixels
- The height of the output image that is used in conjunction with theWidthPixels
parameter. When bothHeightPixels
andWidthPixels
parameters are provided, the image will be stretched to fit the specified aspect ratio. If only theHeightPixels
parameter is provided, its original aspect ratio will be used to calculate theWidthPixels
ratio. If neither parameter is provided, the original image size will be returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-