Interface TextOptions.Builder

All Superinterfaces:
Buildable, CopyableBuilder<TextOptions.Builder,TextOptions>, SdkBuilder<TextOptions.Builder,TextOptions>, SdkPojo
Enclosing class:
TextOptions

public static interface TextOptions.Builder extends SdkPojo, CopyableBuilder<TextOptions.Builder,TextOptions>
  • Method Details

    • defaultValue

      TextOptions.Builder defaultValue(String defaultValue)
      A value to use for the field if the field isn't specified for a document.
      Parameters:
      defaultValue - A value to use for the field if the field isn't specified for a document.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • sourceField

      TextOptions.Builder sourceField(String sourceField)
      Sets the value of the SourceField property for this object.
      Parameters:
      sourceField - The new value for the SourceField property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • returnEnabled

      TextOptions.Builder returnEnabled(Boolean returnEnabled)

      Whether the contents of the field can be returned in the search results.

      Parameters:
      returnEnabled - Whether the contents of the field can be returned in the search results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • sortEnabled

      TextOptions.Builder sortEnabled(Boolean sortEnabled)

      Whether the field can be used to sort the search results.

      Parameters:
      sortEnabled - Whether the field can be used to sort the search results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • highlightEnabled

      TextOptions.Builder highlightEnabled(Boolean highlightEnabled)

      Whether highlights can be returned for the field.

      Parameters:
      highlightEnabled - Whether highlights can be returned for the field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • analysisScheme

      TextOptions.Builder analysisScheme(String analysisScheme)

      The name of an analysis scheme for a text field.

      Parameters:
      analysisScheme - The name of an analysis scheme for a text field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.