Class ColumnConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ColumnConfiguration.Builder,
ColumnConfiguration>
Provides information about how Amazon Kendra should use the columns of a database in an index.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ColumnConfiguration.Builder
builder()
One to five columns that indicate when a document in the database has changed.final String
The column that contains the contents of the document.final String
The column that provides the document's identifier.final String
The column that contains the title of the document.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.An array of objects that map database column names to the corresponding fields in an index.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the ChangeDetectingColumns property.final boolean
For responses, this returns true if the service returned a value for the FieldMappings property.final int
hashCode()
static Class
<? extends ColumnConfiguration.Builder> 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
documentIdColumnName
The column that provides the document's identifier.
- Returns:
- The column that provides the document's identifier.
-
documentDataColumnName
The column that contains the contents of the document.
- Returns:
- The column that contains the contents of the document.
-
documentTitleColumnName
The column that contains the title of the document.
- Returns:
- The column that contains the title of the document.
-
hasFieldMappings
public final boolean hasFieldMappings()For responses, this returns true if the service returned a value for the FieldMappings property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
fieldMappings
An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the
UpdateIndex
API.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
hasFieldMappings()
method.- Returns:
- An array of objects that map database column names to the corresponding fields in an index. You must
first create the fields in the index using the
UpdateIndex
API.
-
hasChangeDetectingColumns
public final boolean hasChangeDetectingColumns()For responses, this returns true if the service returned a value for the ChangeDetectingColumns property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
changeDetectingColumns
One to five columns that indicate when a document in the database has changed.
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
hasChangeDetectingColumns()
method.- Returns:
- One to five columns that indicate when a document in the database has changed.
-
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 interfaceToCopyableBuilder<ColumnConfiguration.Builder,
ColumnConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-