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

Class UpdateExampleOptions

java.lang.Object

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

com.ibm.watson.assistant.v1.model.UpdateExampleOptions

All Implemented Interfaces:

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

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

The updateExample options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
Boolean	includeAudit()	Gets the includeAudit.
String	intent()	Gets the intent.
UpdateExampleOptions.Builder	newBuilder()	New builder.
List<Mention>	newMentions()	Gets the newMentions.
String	newText()	Gets the newText.
String	text()	Gets the text.
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 UpdateExampleOptions.Builder newBuilder()

New builder.

Returns:

a UpdateExampleOptions builder

workspaceId

public String workspaceId()

Gets the workspaceId.

Unique identifier of the workspace.

Returns:

the workspaceId

intent

public String intent()

Gets the intent.

The intent name.

Returns:

the intent

text

public String text()

Gets the text.

The text of the user input example.

Returns:

the text

newText

public String newText()

Gets the newText.

The text of the user input example. 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 newText

newMentions

public List<Mention> newMentions()

Gets the newMentions.

An array of contextual entity mentions.

Returns:

the newMentions

includeAudit

public Boolean includeAudit()

Gets the includeAudit.

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

Returns:

the includeAudit