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 and Description
static class	UpdateSynonymOptions.Builder Builder.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	entity
protected java.lang.Boolean	includeAudit
protected java.lang.String	newSynonym
protected java.lang.String	synonym
protected java.lang.String	value
protected java.lang.String	workspaceId

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UpdateSynonymOptions(UpdateSynonymOptions.Builder builder)

Method Summary

Methods

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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

workspaceId

protected java.lang.String workspaceId

entity

protected java.lang.String entity

value

protected java.lang.String value

synonym

protected java.lang.String synonym

newSynonym

protected java.lang.String newSynonym

includeAudit

protected java.lang.Boolean includeAudit

Constructor Detail

UpdateSynonymOptions

protected UpdateSynonymOptions(UpdateSynonymOptions.Builder builder)

Method Detail

newBuilder

public UpdateSynonymOptions.Builder newBuilder()

New builder.

Returns:

a UpdateSynonymOptions builder

workspaceId

public java.lang.String workspaceId()

Gets the workspaceId.

Unique identifier of the workspace.

Returns:

the workspaceId

entity

public java.lang.String entity()

Gets the entity.

The name of the entity.

Returns:

the entity

value

public java.lang.String value()

Gets the value.

The text of the entity value.

Returns:

the value

synonym

public java.lang.String synonym()

Gets the synonym.

The text of the synonym.

Returns:

the synonym

newSynonym

public java.lang.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 java.lang.Boolean includeAudit()

Gets the includeAudit.

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

Returns:

the includeAudit