Package com.ibm.watson.assistant.v1.model

Class ListSynonymsOptions

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

  • Method Details

    • newBuilder

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

    • workspaceId

      public String workspaceId()
      Gets the workspaceId.

      Unique identifier of the workspace.

      Returns:
      the workspaceId

    • entity

      public String entity()
      Gets the entity.

      The name of the entity.

      Returns:
      the entity

    • value

      public String value()
      Gets the value.

      The text of the entity value.

      Returns:
      the value

    • pageLimit

      public Long pageLimit()
      Gets the pageLimit.

      The number of records to return in each page of results.

      Returns:
      the pageLimit

    • includeCount

      public Boolean includeCount()
      Gets the includeCount.

      Whether to include information about the number of records that satisfy the request, regardless of the page limit. If this parameter is `true`, the `pagination` object in the response includes the `total` property.

      Returns:
      the includeCount

    • sort

      public String sort()
      Gets the sort.

      The attribute by which returned entity value synonyms will be sorted. To reverse the sort order, prefix the value with a minus sign (`-`).

      Returns:
      the sort

    • cursor

      public String cursor()
      Gets the cursor.

      A token identifying the page of results to retrieve.

      Returns:
      the cursor

    • includeAudit

      public Boolean includeAudit()
      Gets the includeAudit.

      Whether to include the audit properties (`created` and `updated` timestamps) in the response.

      Returns:
      the includeAudit