Class RetrievalResultS3Location

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.RetrievalResultS3Location

All Implemented Interfaces:

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

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

The S3 data source location.

This data type is used in the following API operations:

• Retrieve response – in the s3Location field

• RetrieveAndGenerate response – in the s3Location field

• InvokeAgent response – in the s3Location field

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RetrievalResultS3Location.Builder

Method Summary

Modifier and Type	Method	Description
static RetrievalResultS3Location.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final List<SdkField<?>>	sdkFields()
static Class<? extends RetrievalResultS3Location.Builder>	serializableBuilderClass()
RetrievalResultS3Location.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.
final String	uri()	The S3 URI for the data source location.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

uri

public final String uri()

The S3 URI for the data source location.

Returns:

The S3 URI for the data source location.

toBuilder

public RetrievalResultS3Location.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RetrievalResultS3Location.Builder,RetrievalResultS3Location>

Returns:

a builder for type T

builder

public static RetrievalResultS3Location.Builder builder()

serializableBuilderClass

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

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.