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

Class ImageInput

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.ImageInput

All Implemented Interfaces:

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

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

Details about an image in the result from a function in the action group invocation. You can specify images only when the function is a computer use action. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ImageInput.Builder

Method Summary

Modifier and Type	Method	Description
static ImageInput.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ImageInputFormat	format()	The type of image in the result.
String	formatAsString()	The type of image in the result.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ImageInput.Builder>	serializableBuilderClass()
ImageInputSource	source()	The source of the image in the result.
ImageInput.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 ImageInputFormat format()

The type of image in the result.

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

Returns:

The type of image in the result.

See Also:

ImageInputFormat

formatAsString

public final String formatAsString()

The type of image in the result.

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

Returns:

The type of image in the result.

See Also:

ImageInputFormat

source

public final ImageInputSource source()

The source of the image in the result.

Returns:

The source of the image in the result.

toBuilder

public ImageInput.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ImageInput.Builder,ImageInput>

builder

public static ImageInput.Builder builder()

serializableBuilderClass

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