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

Class GetEntityOptions

java.lang.Object

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

com.ibm.watson.assistant.v1.model.GetEntityOptions

All Implemented Interfaces:

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

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

The getEntity options.

Nested Class Summary

Nested Classes

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

Method Summary

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

New builder.

Returns:

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

export

public Boolean export()

Gets the export.

Whether to include all element content in the returned data. If **export**=`false`, the returned data includes only information about the element itself. If **export**=`true`, all content, including subelements, is included.

Returns:

the export

includeAudit

public Boolean includeAudit()

Gets the includeAudit.

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

Returns:

the includeAudit