Class TransformationConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.TransformationConfiguration

All Implemented Interfaces:

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

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

Contains configurations for transforming the natural language query into SQL.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TransformationConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static TransformationConfiguration.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 QueryTransformationMode	mode()	The mode of the transformation.
final String	modeAsString()	The mode of the transformation.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends TransformationConfiguration.Builder>	serializableBuilderClass()
final TextToSqlConfiguration	textToSqlConfiguration()	Specifies configurations for transforming text to SQL.
TransformationConfiguration.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.

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

mode

public final QueryTransformationMode mode()

The mode of the transformation.

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

Returns:

The mode of the transformation.

See Also:

• QueryTransformationMode

modeAsString

public final String modeAsString()

The mode of the transformation.

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

Returns:

The mode of the transformation.

See Also:

• QueryTransformationMode

textToSqlConfiguration

public final TextToSqlConfiguration textToSqlConfiguration()

Specifies configurations for transforming text to SQL.

Returns:

Specifies configurations for transforming text to SQL.

toBuilder

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

Returns:

a builder for type T

builder

public static TransformationConfiguration.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.