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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	entity
protected java.lang.Boolean	export
protected java.lang.Boolean	includeAudit
protected java.lang.String	workspaceId

Constructor Summary

Constructors

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

Method Summary

Methods

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

export

protected java.lang.Boolean export

includeAudit

protected java.lang.Boolean includeAudit

Constructor Detail

GetEntityOptions

protected GetEntityOptions(GetEntityOptions.Builder builder)

Method Detail

newBuilder

public GetEntityOptions.Builder newBuilder()

New builder.

Returns:

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

export

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

Gets the includeAudit.

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

Returns:

the includeAudit