Package software.amazon.awssdk.services.bedrockruntime.model

Class ImageSource

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.ImageSource

All Implemented Interfaces:

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

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

The source for an image.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ImageSource.Builder
static enum	ImageSource.Type

Method Summary

Modifier and Type	Method	Description
static ImageSource.Builder	builder()
final SdkBytes	bytes()	The raw image bytes for the image.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
static ImageSource	fromBytes(SdkBytes bytes)	Create an instance of this class with bytes() initialized to the given value.
static ImageSource	fromS3Location(Consumer<S3Location.Builder> s3Location)	Create an instance of this class with s3Location() initialized to the given value.
static ImageSource	fromS3Location(S3Location s3Location)	Create an instance of this class with s3Location() initialized to the given value.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final S3Location	s3Location()	The location of an image object in an Amazon S3 bucket.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends ImageSource.Builder>	serializableBuilderClass()
ImageSource.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.
ImageSource.Type	type()	Retrieve an enum value representing which member of this object is populated.

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 Details

bytes

public final SdkBytes bytes()

The raw image bytes for the image. If you use an AWS SDK, you don't need to encode the image bytes in base64.

Returns:

The raw image bytes for the image. If you use an AWS SDK, you don't need to encode the image bytes in base64.

s3Location

public final S3Location s3Location()

The location of an image object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse.

Returns:

The location of an image object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse.

toBuilder

public ImageSource.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ImageSource.Builder,ImageSource>

builder

public static ImageSource.Builder builder()

serializableBuilderClass

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

fromBytes

public static ImageSource fromBytes(SdkBytes bytes)

Create an instance of this class with bytes() initialized to the given value.

The raw image bytes for the image. If you use an AWS SDK, you don't need to encode the image bytes in base64.

Parameters:

bytes - The raw image bytes for the image. If you use an AWS SDK, you don't need to encode the image bytes in base64.

fromS3Location

public static ImageSource fromS3Location(S3Location s3Location)

Create an instance of this class with s3Location() initialized to the given value.

The location of an image object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse.

Parameters:

s3Location - The location of an image object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse.

fromS3Location

public static ImageSource fromS3Location(Consumer<S3Location.Builder> s3Location)

Create an instance of this class with s3Location() initialized to the given value.

The location of an image object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse.

Parameters:

s3Location - The location of an image object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse.

type

public ImageSource.Type type()

Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be ImageSource.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be ImageSource.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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