com.ibm.watson.assistant.v1.model

Class GetWorkspaceOptions

java.lang.Object

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

com.ibm.watson.assistant.v1.model.GetWorkspaceOptions

All Implemented Interfaces:

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

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

The getWorkspace options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetWorkspaceOptions.Builder Builder.
static interface	GetWorkspaceOptions.Sort Indicates how the returned workspace data will be sorted.

Method Summary

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

New builder.

Returns:

a GetWorkspaceOptions builder

workspaceId

public String workspaceId()

Gets the workspaceId.

Unique identifier of the workspace.

Returns:

the workspaceId

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

sort

public String sort()

Gets the sort.

Indicates how the returned workspace data will be sorted. This parameter is valid only if **export**=`true`. Specify `sort=stable` to sort all workspace objects by unique identifier, in ascending alphabetical order.

Returns:

the sort