Package software.amazon.awssdk.services.bedrockagentruntime.model

Class InputImage

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.InputImage

All Implemented Interfaces:

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

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

Contains the image data for multimodal knowledge base queries, including format and content.

This data type is used in the following API operations:

• Retrieve request – in the image field

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InputImage.Builder

Method Summary

Modifier and Type	Method	Description
static InputImage.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
InputImageFormat	format()	The format of the input image.
String	formatAsString()	The format of the input image.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
SdkBytes	inlineContent()	The base64-encoded image data for inline image content.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends InputImage.Builder>	serializableBuilderClass()
InputImage.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

format

public final InputImageFormat format()

The format of the input image. Supported formats include png, gif, jpeg, and webp.

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

Returns:

The format of the input image. Supported formats include png, gif, jpeg, and webp.

See Also:

InputImageFormat

formatAsString

public final String formatAsString()

The format of the input image. Supported formats include png, gif, jpeg, and webp.

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

Returns:

The format of the input image. Supported formats include png, gif, jpeg, and webp.

See Also:

InputImageFormat

inlineContent

public final SdkBytes inlineContent()

The base64-encoded image data for inline image content. Maximum size is 5MB.

Returns:

The base64-encoded image data for inline image content. Maximum size is 5MB.

toBuilder

public InputImage.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InputImage.Builder,InputImage>

builder

public static InputImage.Builder builder()

serializableBuilderClass

public static Class<? extends InputImage.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo