com.ibm.watson.assistant.v1.model

Class ListWorkspacesOptions

java.lang.Object

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

com.ibm.watson.assistant.v1.model.ListWorkspacesOptions

All Implemented Interfaces:

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

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

The listWorkspaces options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListWorkspacesOptions.Builder Builder.
static interface	ListWorkspacesOptions.Sort The attribute by which returned workspaces will be sorted.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	cursor
protected java.lang.Boolean	includeAudit
protected java.lang.Long	pageLimit
protected java.lang.String	sort

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	cursor() Gets the cursor.
java.lang.Boolean	includeAudit() Gets the includeAudit.
ListWorkspacesOptions.Builder	newBuilder() New builder.
java.lang.Long	pageLimit() Gets the pageLimit.
java.lang.String	sort() Gets the sort.

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

pageLimit

protected java.lang.Long pageLimit

sort

protected java.lang.String sort

cursor

protected java.lang.String cursor

includeAudit

protected java.lang.Boolean includeAudit

Constructor Detail

ListWorkspacesOptions

protected ListWorkspacesOptions(ListWorkspacesOptions.Builder builder)

Method Detail

newBuilder

public ListWorkspacesOptions.Builder newBuilder()

New builder.

Returns:

a ListWorkspacesOptions builder

pageLimit

public java.lang.Long pageLimit()

Gets the pageLimit.

The number of records to return in each page of results.

Returns:

the pageLimit

sort

public java.lang.String sort()

Gets the sort.

The attribute by which returned workspaces will be sorted. To reverse the sort order, prefix the value with a minus sign (`-`).

Returns:

the sort

cursor

public java.lang.String cursor()

Gets the cursor.

A token identifying the page of results to retrieve.

Returns:

the cursor

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