Interface SourceDocument.Builder

All Superinterfaces:
Buildable, CopyableBuilder<SourceDocument.Builder,SourceDocument>, SdkBuilder<SourceDocument.Builder,SourceDocument>, SdkPojo
Enclosing class:
SourceDocument
public static interface SourceDocument.Builder extends SdkPojo, CopyableBuilder<SourceDocument.Builder,SourceDocument>

  • Method Details

    • documentId

      SourceDocument.Builder documentId(String documentId)

      The identifier of the document used for a query suggestion.

      Parameters:
      documentId - The identifier of the document used for a query suggestion.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • suggestionAttributes

      SourceDocument.Builder suggestionAttributes(Collection<String> suggestionAttributes)

      The document fields/attributes used for a query suggestion.

      Parameters:
      suggestionAttributes - The document fields/attributes used for a query suggestion.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • suggestionAttributes

      SourceDocument.Builder suggestionAttributes(String... suggestionAttributes)

      The document fields/attributes used for a query suggestion.

      Parameters:
      suggestionAttributes - The document fields/attributes used for a query suggestion.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalAttributes

      SourceDocument.Builder additionalAttributes(Collection<DocumentAttribute> additionalAttributes)

      The additional fields/attributes to include in the response. You can use additional fields to provide extra information in the response. Additional fields are not used to based suggestions on.

      Parameters:
      additionalAttributes - The additional fields/attributes to include in the response. You can use additional fields to provide extra information in the response. Additional fields are not used to based suggestions on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalAttributes

      SourceDocument.Builder additionalAttributes(DocumentAttribute... additionalAttributes)

      The additional fields/attributes to include in the response. You can use additional fields to provide extra information in the response. Additional fields are not used to based suggestions on.

      Parameters:
      additionalAttributes - The additional fields/attributes to include in the response. You can use additional fields to provide extra information in the response. Additional fields are not used to based suggestions on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalAttributes

      SourceDocument.Builder additionalAttributes(Consumer<DocumentAttribute.Builder>... additionalAttributes)

      The additional fields/attributes to include in the response. You can use additional fields to provide extra information in the response. Additional fields are not used to based suggestions on.

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

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

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