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

Class QueryGenerationTable

java.lang.Object

software.amazon.awssdk.services.bedrockagent.model.QueryGenerationTable

All Implemented Interfaces:

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

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

Contains information about a table for the query engine to consider.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	QueryGenerationTable.Builder

Method Summary

Modifier and Type	Method	Description
static QueryGenerationTable.Builder	builder()
List<QueryGenerationColumn>	columns()	An array of objects, each of which defines information about a column in the table.
String	description()	A description of the table that helps the query engine understand the contents of the table.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasColumns()	For responses, this returns true if the service returned a value for the Columns property.
int	hashCode()
IncludeExclude	inclusion()	Specifies whether to include or exclude the table during query generation.
String	inclusionAsString()	Specifies whether to include or exclude the table during query generation.
String	name()	The name of the table for which the other fields in this object apply.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends QueryGenerationTable.Builder>	serializableBuilderClass()
QueryGenerationTable.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

name

public final String name()

The name of the table for which the other fields in this object apply.

Returns:

The name of the table for which the other fields in this object apply.

description

public final String description()

A description of the table that helps the query engine understand the contents of the table.

Returns:

A description of the table that helps the query engine understand the contents of the table.

inclusion

public final IncludeExclude inclusion()

Specifies whether to include or exclude the table during query generation. If you specify EXCLUDE, the table will be ignored. If you specify INCLUDE, all other tables will be ignored.

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

Returns:

Specifies whether to include or exclude the table during query generation. If you specify EXCLUDE, the table will be ignored. If you specify INCLUDE, all other tables will be ignored.

See Also:

IncludeExclude

inclusionAsString

public final String inclusionAsString()

Specifies whether to include or exclude the table during query generation. If you specify EXCLUDE, the table will be ignored. If you specify INCLUDE, all other tables will be ignored.

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

Returns:

Specifies whether to include or exclude the table during query generation. If you specify EXCLUDE, the table will be ignored. If you specify INCLUDE, all other tables will be ignored.

See Also:

IncludeExclude

hasColumns

public final boolean hasColumns()

For responses, this returns true if the service returned a value for the Columns 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.

columns

public final List<QueryGenerationColumn> columns()

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

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 hasColumns() method.

Returns:

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

toBuilder

public QueryGenerationTable.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<QueryGenerationTable.Builder,QueryGenerationTable>

builder

public static QueryGenerationTable.Builder builder()

serializableBuilderClass

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