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:

  • Method Details

    • 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:

    • 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:

    • 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()
      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<QueryGenerationTable.Builder,QueryGenerationTable>
      Returns:
      a builder for type T

    • 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)
      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.