com.ibm.watson.assistant.v1.model

Class UpdateIntentOptions

java.lang.Object

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

com.ibm.watson.assistant.v1.model.UpdateIntentOptions

All Implemented Interfaces:

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

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

The updateIntent options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
Boolean	append() Gets the append.
Boolean	includeAudit() Gets the includeAudit.
String	intent() Gets the intent.
UpdateIntentOptions.Builder	newBuilder() New builder.
String	newDescription() Gets the newDescription.
List<Example>	newExamples() Gets the newExamples.
String	newIntent() Gets the newIntent.
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 Detail

newBuilder

public UpdateIntentOptions.Builder newBuilder()

New builder.

Returns:

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

newIntent

public String newIntent()

Gets the newIntent.

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix `sys-`.

Returns:

the newIntent

newDescription

public String newDescription()

Gets the newDescription.

The description of the intent. This string cannot contain carriage return, newline, or tab characters.

Returns:

the newDescription

newExamples

public List<Example> newExamples()

Gets the newExamples.

An array of user input examples for the intent.

Returns:

the newExamples

append

public Boolean append()

Gets the append.

Whether the new data is to be appended to the existing data in the object. If **append**=`false`, elements included in the new data completely replace the corresponding existing elements, including all subelements. For example, if the new data for the intent includes **examples** and **append**=`false`, all existing examples for the intent are discarded and replaced with the new examples.

If **append**=`true`, existing elements are preserved, and the new elements are added. If any elements in the new data collide with existing elements, the update request fails.

Returns:

the append

includeAudit

public Boolean includeAudit()

Gets the includeAudit.

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

Returns:

the includeAudit