Class QueryGenerationColumn

java.lang.Object
software.amazon.awssdk.services.bedrockagent.model.QueryGenerationColumn
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<QueryGenerationColumn.Builder,QueryGenerationColumn>
@Generated("software.amazon.awssdk:codegen") public final class QueryGenerationColumn extends Object implements SdkPojo, Serializable, ToCopyableBuilder<QueryGenerationColumn.Builder,QueryGenerationColumn>

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

See Also:

  • Method Details

    • description

      public final String description()

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

      Returns:
      A description of the column that helps the query engine understand the contents of the column.

    • inclusion

      public final IncludeExclude inclusion()

      Specifies whether to include or exclude the column during query generation. If you specify EXCLUDE, the column will be ignored. If you specify INCLUDE, all other columns in the table 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 column during query generation. If you specify EXCLUDE, the column will be ignored. If you specify INCLUDE, all other columns in the table will be ignored.
      See Also:

    • inclusionAsString

      public final String inclusionAsString()

      Specifies whether to include or exclude the column during query generation. If you specify EXCLUDE, the column will be ignored. If you specify INCLUDE, all other columns in the table 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 column during query generation. If you specify EXCLUDE, the column will be ignored. If you specify INCLUDE, all other columns in the table will be ignored.
      See Also:

    • name

      public final String name()

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

      Returns:
      The name of the column for which the other fields in this object apply.

    • toBuilder

      public QueryGenerationColumn.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<QueryGenerationColumn.Builder,QueryGenerationColumn>
      Returns:
      a builder for type T

    • builder

      public static QueryGenerationColumn.Builder builder()

    • serializableBuilderClass

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