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.
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ListSynonymsOptions.Builder
Builder.static interface
ListSynonymsOptions.Sort
The attribute by which returned entity value synonyms will be sorted. -
Method Summary
Modifier and Type Method Description String
cursor()
Gets the cursor.String
entity()
Gets the entity.Boolean
includeAudit()
Gets the includeAudit.Boolean
includeCount()
Gets the includeCount.ListSynonymsOptions.Builder
newBuilder()
New builder.Long
pageLimit()
Gets the pageLimit.String
sort()
Gets the sort.String
value()
Gets the value.String
workspaceId()
Gets the workspaceId.Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel
equals, hashCode, toString
-
Method Details
-
newBuilder
New builder.- Returns:
- a ListSynonymsOptions builder
-
workspaceId
Gets the workspaceId.Unique identifier of the workspace.
- Returns:
- the workspaceId
-
entity
Gets the entity.The name of the entity.
- Returns:
- the entity
-
value
Gets the value.The text of the entity value.
- Returns:
- the value
-
pageLimit
Gets the pageLimit.The number of records to return in each page of results.
- Returns:
- the pageLimit
-
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
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
Gets the cursor.A token identifying the page of results to retrieve.
- Returns:
- the cursor
-
includeAudit
Gets the includeAudit.Whether to include the audit properties (`created` and `updated` timestamps) in the response.
- Returns:
- the includeAudit
-