Package com.ibm.watson.compare_comply.v1.model

Class ListFeedbackOptions

java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.watson.compare_comply.v1.model.ListFeedbackOptions
All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel
public class ListFeedbackOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel
The listFeedback options.

  • Method Details

    • newBuilder

      public ListFeedbackOptions.Builder newBuilder()
      New builder.
      Returns:
      a ListFeedbackOptions builder

    • feedbackType

      public String feedbackType()
      Gets the feedbackType.

      An optional string that filters the output to include only feedback with the specified feedback type. The only permitted value is `element_classification`.

      Returns:
      the feedbackType

    • documentTitle

      public String documentTitle()
      Gets the documentTitle.

      An optional string that filters the output to include only feedback from the document with the specified `document_title`.

      Returns:
      the documentTitle

    • modelId

      public String modelId()
      Gets the modelId.

      An optional string that filters the output to include only feedback with the specified `model_id`. The only permitted value is `contracts`.

      Returns:
      the modelId

    • modelVersion

      public String modelVersion()
      Gets the modelVersion.

      An optional string that filters the output to include only feedback with the specified `model_version`.

      Returns:
      the modelVersion

    • categoryRemoved

      public String categoryRemoved()
      Gets the categoryRemoved.

      An optional string in the form of a comma-separated list of categories. If it is specified, the service filters the output to include only feedback that has at least one category from the list removed.

      Returns:
      the categoryRemoved

    • categoryAdded

      public String categoryAdded()
      Gets the categoryAdded.

      An optional string in the form of a comma-separated list of categories. If this is specified, the service filters the output to include only feedback that has at least one category from the list added.

      Returns:
      the categoryAdded

    • categoryNotChanged

      public String categoryNotChanged()
      Gets the categoryNotChanged.

      An optional string in the form of a comma-separated list of categories. If this is specified, the service filters the output to include only feedback that has at least one category from the list unchanged.

      Returns:
      the categoryNotChanged

    • typeRemoved

      public String typeRemoved()
      Gets the typeRemoved.

      An optional string of comma-separated `nature`:`party` pairs. If this is specified, the service filters the output to include only feedback that has at least one `nature`:`party` pair from the list removed.

      Returns:
      the typeRemoved

    • typeAdded

      public String typeAdded()
      Gets the typeAdded.

      An optional string of comma-separated `nature`:`party` pairs. If this is specified, the service filters the output to include only feedback that has at least one `nature`:`party` pair from the list removed.

      Returns:
      the typeAdded

    • typeNotChanged

      public String typeNotChanged()
      Gets the typeNotChanged.

      An optional string of comma-separated `nature`:`party` pairs. If this is specified, the service filters the output to include only feedback that has at least one `nature`:`party` pair from the list unchanged.

      Returns:
      the typeNotChanged

    • pageLimit

      public Long pageLimit()
      Gets the pageLimit.

      An optional integer specifying the number of documents that you want the service to return.

      Returns:
      the pageLimit

    • cursor

      public String cursor()
      Gets the cursor.

      An optional string that returns the set of documents after the previous set. Use this parameter with the `page_limit` parameter.

      Returns:
      the cursor

    • sort

      public String sort()
      Gets the sort.

      An optional comma-separated list of fields in the document to sort on. You can optionally specify the sort direction by prefixing the value of the field with `-` for descending order or `+` for ascending order (the default). Currently permitted sorting fields are `created`, `user_id`, and `document_title`.

      Returns:
      the sort

    • includeTotal

      public Boolean includeTotal()
      Gets the includeTotal.

      An optional boolean value. If specified as `true`, the `pagination` object in the output includes a value called `total` that gives the total count of feedback created.

      Returns:
      the includeTotal