Package 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	Description
static class	ListWorkspacesOptions.Builder	Builder.
static interface	ListWorkspacesOptions.Sort	The attribute by which returned workspaces will be sorted.

Method Summary

Modifier and Type	Method	Description
String	cursor()	Gets the cursor.
Boolean	includeAudit()	Gets the includeAudit.
Boolean	includeCount()	Gets the includeCount.
ListWorkspacesOptions.Builder	newBuilder()	New builder.
Long	pageLimit()	Gets the pageLimit.
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

getClass, notify, notifyAll, wait, wait, wait

Method Details

newBuilder

public ListWorkspacesOptions.Builder newBuilder()

New builder.

Returns:

a ListWorkspacesOptions builder

pageLimit

public Long pageLimit()

Gets the pageLimit.

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

Returns:

the pageLimit

includeCount

public Boolean includeCount()

Gets the includeCount.

Whether to include information about the number of records that satisfy the request, regardless of the page limit. If this parameter is `true`, the `pagination` object in the response includes the `total` property.

Returns:

the includeCount

sort

public 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 String cursor()

Gets the cursor.

A token identifying the page of results to retrieve.

Returns:

the cursor

includeAudit

public Boolean includeAudit()

Gets the includeAudit.

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

Returns:

the includeAudit