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

Class RetrievalResultLocation

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.RetrievalResultLocation

All Implemented Interfaces:

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

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

Contains information about the location of the data source.

This data type is used in the following API operations:

• Retrieve response – in the location field

• RetrieveAndGenerate response – in the location field

• Retrieve response – in the locatino field

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RetrievalResultLocation.Builder

Method Summary

Modifier and Type	Method	Description
static RetrievalResultLocation.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 RetrievalResultS3Location	s3Location()	Contains the S3 location of the data source.
final List<SdkField<?>>	sdkFields()
static Class<? extends RetrievalResultLocation.Builder>	serializableBuilderClass()
RetrievalResultLocation.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 RetrievalResultLocationType	type()	The type of the location of the data source.
final String	typeAsString()	The type of the location of the data source.

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

s3Location

public final RetrievalResultS3Location s3Location()

Contains the S3 location of the data source.

Returns:

Contains the S3 location of the data source.

type

public final RetrievalResultLocationType type()

The type of the location of the data source.

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

Returns:

The type of the location of the data source.

See Also:

• RetrievalResultLocationType

typeAsString

public final String typeAsString()

The type of the location of the data source.

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

Returns:

The type of the location of the data source.

See Also:

• RetrievalResultLocationType

toBuilder

public RetrievalResultLocation.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<RetrievalResultLocation.Builder,RetrievalResultLocation>

Returns:

a builder for type T

builder

public static RetrievalResultLocation.Builder builder()

serializableBuilderClass

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