Package software.amazon.awssdk.services.bedrockagent.model

Class QueryGenerationContext

java.lang.Object

software.amazon.awssdk.services.bedrockagent.model.QueryGenerationContext

All Implemented Interfaces:

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

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

>Contains configurations for context to use during query generation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	QueryGenerationContext.Builder

Method Summary

Modifier and Type	Method	Description
static QueryGenerationContext.Builder	builder()
List<CuratedQuery>	curatedQueries()	An array of objects, each of which defines information about example queries to help the query engine generate appropriate SQL queries.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCuratedQueries()	For responses, this returns true if the service returned a value for the CuratedQueries property.
int	hashCode()
boolean	hasTables()	For responses, this returns true if the service returned a value for the Tables property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends QueryGenerationContext.Builder>	serializableBuilderClass()
List<QueryGenerationTable>	tables()	An array of objects, each of which defines information about a table in the database.
QueryGenerationContext.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

hasTables

public final boolean hasTables()

For responses, this returns true if the service returned a value for the Tables property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tables

public final List<QueryGenerationTable> tables()

An array of objects, each of which defines information about a table in the database.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTables() method.

Returns:

An array of objects, each of which defines information about a table in the database.

hasCuratedQueries

public final boolean hasCuratedQueries()

For responses, this returns true if the service returned a value for the CuratedQueries property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

curatedQueries

public final List<CuratedQuery> curatedQueries()

An array of objects, each of which defines information about example queries to help the query engine generate appropriate SQL queries.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCuratedQueries() method.

Returns:

An array of objects, each of which defines information about example queries to help the query engine generate appropriate SQL queries.

toBuilder

public QueryGenerationContext.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<QueryGenerationContext.Builder,QueryGenerationContext>

builder

public static QueryGenerationContext.Builder builder()

serializableBuilderClass

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