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.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Boolean	append
protected java.lang.Boolean	includeAudit
protected java.lang.String	intent
protected java.lang.String	newDescription
protected java.util.List<Example>	newExamples
protected java.lang.String	newIntent
protected java.lang.String	workspaceId

Constructor Summary

Constructors

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

Method Summary

Methods

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

intent

protected java.lang.String intent

newIntent

protected java.lang.String newIntent

newDescription

protected java.lang.String newDescription

newExamples

protected java.util.List<Example> newExamples

append

protected java.lang.Boolean append

includeAudit

protected java.lang.Boolean includeAudit

Constructor Detail

UpdateIntentOptions

protected UpdateIntentOptions(UpdateIntentOptions.Builder builder)

Method Detail

newBuilder

public UpdateIntentOptions.Builder newBuilder()

New builder.

Returns:

a UpdateIntentOptions builder

workspaceId

public java.lang.String workspaceId()

Gets the workspaceId.

Unique identifier of the workspace.

Returns:

the workspaceId

intent

public java.lang.String intent()

Gets the intent.

The intent name.

Returns:

the intent

newIntent

public java.lang.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 java.lang.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 java.util.List<Example> newExamples()

Gets the newExamples.

An array of user input examples for the intent.

Returns:

the newExamples

append

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

Gets the includeAudit.

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

Returns:

the includeAudit