Interface SentimentFilter.Builder

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

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

    • sentimentsWithStrings

      SentimentFilter.Builder sentimentsWithStrings(Collection<String> sentiments)

      Specify the sentiments that you want to flag.

      Parameters:
      sentiments - Specify the sentiments that you want to flag.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • sentimentsWithStrings

      SentimentFilter.Builder sentimentsWithStrings(String... sentiments)

      Specify the sentiments that you want to flag.

      Parameters:
      sentiments - Specify the sentiments that you want to flag.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • sentiments

      Specify the sentiments that you want to flag.

      Parameters:
      sentiments - Specify the sentiments that you want to flag.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • sentiments

      SentimentFilter.Builder sentiments(SentimentValue... sentiments)

      Specify the sentiments that you want to flag.

      Parameters:
      sentiments - Specify the sentiments that you want to flag.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • absoluteTimeRange

      SentimentFilter.Builder absoluteTimeRange(AbsoluteTimeRange absoluteTimeRange)

      Makes it possible to specify a time range (in milliseconds) in your audio, during which you want to search for the specified sentiments. See for more detail.

      Parameters:
      absoluteTimeRange - Makes it possible to specify a time range (in milliseconds) in your audio, during which you want to search for the specified sentiments. See for more detail.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • absoluteTimeRange

      default SentimentFilter.Builder absoluteTimeRange(Consumer<AbsoluteTimeRange.Builder> absoluteTimeRange)

      Makes it possible to specify a time range (in milliseconds) in your audio, during which you want to search for the specified sentiments. See for more detail.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to absoluteTimeRange(AbsoluteTimeRange).

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

      SentimentFilter.Builder relativeTimeRange(RelativeTimeRange relativeTimeRange)

      Makes it possible to specify a time range (in percentage) in your media file, during which you want to search for the specified sentiments. See for more detail.

      Parameters:
      relativeTimeRange - Makes it possible to specify a time range (in percentage) in your media file, during which you want to search for the specified sentiments. See for more detail.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • relativeTimeRange

      default SentimentFilter.Builder relativeTimeRange(Consumer<RelativeTimeRange.Builder> relativeTimeRange)

      Makes it possible to specify a time range (in percentage) in your media file, during which you want to search for the specified sentiments. See for more detail.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to relativeTimeRange(RelativeTimeRange).

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

      SentimentFilter.Builder participantRole(String participantRole)

      Specify the participant that you want to flag. Omitting this parameter is equivalent to specifying both participants.

      Parameters:
      participantRole - Specify the participant that you want to flag. Omitting this parameter is equivalent to specifying both participants.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • participantRole

      SentimentFilter.Builder participantRole(ParticipantRole participantRole)

      Specify the participant that you want to flag. Omitting this parameter is equivalent to specifying both participants.

      Parameters:
      participantRole - Specify the participant that you want to flag. Omitting this parameter is equivalent to specifying both participants.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • negate

      Set to TRUE to flag the sentiments that you didn't include in your request. Set to FALSE to flag the sentiments that you specified in your request.

      Parameters:
      negate - Set to TRUE to flag the sentiments that you didn't include in your request. Set to FALSE to flag the sentiments that you specified in your request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.