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

Class UpdateSynonymOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.assistant.v1.model.UpdateSynonymOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class UpdateSynonymOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The updateSynonym options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UpdateSynonymOptions.Builder	Builder.

Method Summary

Modifier and Type	Method	Description
String	entity()	Gets the entity.
Boolean	includeAudit()	Gets the includeAudit.
UpdateSynonymOptions.Builder	newBuilder()	New builder.
String	newSynonym()	Gets the newSynonym.
String	synonym()	Gets the synonym.
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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

newBuilder

public UpdateSynonymOptions.Builder newBuilder()

New builder.

Returns:

a UpdateSynonymOptions 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

synonym

public String synonym()

Gets the synonym.

The text of the synonym.

Returns:

the synonym

newSynonym

public String newSynonym()

Gets the newSynonym.

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters.

Returns:

the newSynonym

includeAudit

public Boolean includeAudit()

Gets the includeAudit.

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

Returns:

the includeAudit