Interface ColumnConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ColumnConfiguration.Builder,ColumnConfiguration>, SdkBuilder<ColumnConfiguration.Builder,ColumnConfiguration>, SdkPojo
Enclosing class:
ColumnConfiguration
@Mutable @NotThreadSafe public static interface ColumnConfiguration.Builder extends SdkPojo, CopyableBuilder<ColumnConfiguration.Builder,ColumnConfiguration>

  • Method Details

    • documentIdColumnName

      ColumnConfiguration.Builder documentIdColumnName(String documentIdColumnName)

      The column that provides the document's identifier.

      Parameters:
      documentIdColumnName - The column that provides the document's identifier.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • documentDataColumnName

      ColumnConfiguration.Builder documentDataColumnName(String documentDataColumnName)

      The column that contains the contents of the document.

      Parameters:
      documentDataColumnName - The column that contains the contents of the document.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • documentTitleColumnName

      ColumnConfiguration.Builder documentTitleColumnName(String documentTitleColumnName)

      The column that contains the title of the document.

      Parameters:
      documentTitleColumnName - The column that contains the title of the document.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fieldMappings

      ColumnConfiguration.Builder fieldMappings(Collection<DataSourceToIndexFieldMapping> 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fieldMappings

      ColumnConfiguration.Builder fieldMappings(DataSourceToIndexFieldMapping... 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fieldMappings

      ColumnConfiguration.Builder fieldMappings(Consumer<DataSourceToIndexFieldMapping.Builder>... 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.

      This is a convenience method that creates an instance of the DataSourceToIndexFieldMapping.Builder avoiding the need to create one manually via DataSourceToIndexFieldMapping.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to fieldMappings(List<DataSourceToIndexFieldMapping>).

      Parameters:
      fieldMappings - a consumer that will call methods on DataSourceToIndexFieldMapping.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • changeDetectingColumns

      ColumnConfiguration.Builder changeDetectingColumns(Collection<String> changeDetectingColumns)

      One to five columns that indicate when a document in the database has changed.

      Parameters:
      changeDetectingColumns - One to five columns that indicate when a document in the database has changed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • changeDetectingColumns

      ColumnConfiguration.Builder changeDetectingColumns(String... changeDetectingColumns)

      One to five columns that indicate when a document in the database has changed.

      Parameters:
      changeDetectingColumns - One to five columns that indicate when a document in the database has changed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.